Get your current rate limit status

/rate_limit

This call returns information about your current rate limit. This is the number of API calls you can make in five minutes. This call also returns information about your current instance limit.

Path

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/rate_limit

👍

Note that making this API call does not count against your rate limit.

Request

Example request

HTTP

GET /v2/rate_limit HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

cURL

curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/rate_limit"

Header Fields

Name	Description
X-SBG-Auth-Token required	Your authentication token.

Query parameters

Response

See a list of response codes that may be contained in the body of the response.

Example response body

JSON

{
  "rate": {
    "limit": 1000,
    "remaining": 1000,
    "reset":  1489700093
  },
 "instance_limit" : {
    "limit": -1,
    "remaining": 9223372036854775807
 }
}

Interpreting the response body:

For rate:

• limit indicates how many requests can be made in one hour.
• remaining indicates how many requests remain.
• reset indicates the time in Unix epochs when the request rate limit will be reset.

For instance_limit:

• limit indicates the total number of instances available to the user. For the first few months, instance limits are unlimited. This is indicated by a special limit of -1. Correspondingly, the remaining value is high.
• remaining indicates the number of the instances that are available at the moment. For the first few months, instance limits are unlimited. This is indicated by a high remaining value. Correspondingly, the limit is set to a special value of -1.