Analytics API

The Analytics API retrieves call-limit data and the quotas that are set for the RESTful APIs and the legacy Trading API.

Responses from calls made to getRateLimits and getUerRateLimits include a list of the applicable resources and the “call limit”, or quota, that is set for each resource. In addition to quota information, the response also includes the number of remaining calls available before the limit is reached, the time remaining before the quota resets, and the length of the “time window” to which the quota applies.

The getRateLimits and getUserRateLimits methods retrieve call-limit information for either an application or user, respectively, and each method must be called with an appropriate OAuth token. That is, getRateLimites requires an access token generated with a client credentials grant and getUserRateLimites requires an access token generated with an authorization code grant. For more information, see OAuth tokens.

Users can analyze the response data to see whether or not a limit might be reached, and from that determine if any action needs to be taken (such as programmatically throttling their request rate). For more on call limits, see Compatible Application Check.