Get your current rate limit status

/rate_limit

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call returns information about your current rate limit. This is the number of API calls you can make in one hour.

https://cavatica-api.sbgenomics.com/v2/rate_limit

šŸ‘

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

Request

Example request

GET /v2/rate_limit HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X GET "https://cavatica-api.sbgenomics.com/v2/rate_limit"

Header Fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

Query parameters

Name

Data type

Description

fields

string

Selector specifying a subset of fields to include in the response.

Response

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

Example response body

{
  "rate": {
    "limit": 999,
    "remaining": 999,
    "reset": 1445694506797
  }
}

Interpreting the response body:

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

Language
Click Try It! to start a request and see the response here!