GET /Api/Read/Limits
Authorization key & Authorization date & Authorization hmac

This process returns information about your call limits. Note that the limits can be adjusted by WRTM staff which would adjust the return values to what your api key is configured for. Secret Hmac Required. Cache Time 30 Seconds.

Responses

  • 200 application/json

    Limit list successfully returned

    Hide response attribute Show response attribute object
    • TimePeriod array[object]

      The time period. By default, this will return 3 time period array elements. 5Sec is the 5 second time period with 25 max requests. 1Hr is the hourly limit with 500 max requests. 1Mon is the monthly time period with 100,000 max requests.

      Hide TimePeriod attributes Show TimePeriod attributes object
      • Limit number

        The maximum number of requests for this time period.

      • Remain number

        The number of requests available for this time period.

      • ResetDate string

        When the time period resets to 0 used.

      • TimeLeft number

        The time duration left until the time period resets to 0 used.
GET /Api/Read/Limits 
curl \
 --request GET 'https://api.whyreadthemanual.com/v1.0/Api/Read/Limits' \
 --header "X-ApiKey: $API_KEY" \
 --header "X-ApiDate: $API_KEY" \
 --header "X-ApiHmac: $API_KEY"
Response examples (200) 
{
  "1Hr": {
    "Limit": 500,
    "Remain": 222,
    "TimeLeft": "43 Minutes",
    "ResetDate": "Fri, 12 May 2023 20:07:00 GMT"
  },
  "1Mon": {
    "Limit": 100000,
    "Remain": 98379,
    "TimeLeft": "4.3 Weeks",
    "ResetDate": "Mon, 12 Jun 2023 00:00:00 GMT"
  },
  "5Min": {
    "Limit": 3,
    "Remain": 22,
    "TimeLeft": "4 Seconds",
    "ResetDate": "Fri, 12 May 2023 19:07:27 GMT"
  }
}