Credence Global Bank Invest API Documentation

Rate Limiting

Overview

We have implemented a rate limiting system for all authenticated brokerage calls through the API. It is designed to protect accounts from abuse and servers from load. We aim to put limits in place that provide protection but do not hinder the usability of the API.

Limits

These are the current limits in place:

• 40 requests per minute for trade submission calls (ex: POST /v1/account/12345678/orders.xml)
• 60 requests per minute for market/quotes calls
• 180 requests per minute for all other authenticated calls (balances, summary, etc)

Rate Limit Headers

You can find rate limit information in the response headers of all calls that are limited. These headers can help you throttle your application as well as provide information about your current limit quota.

• X-RateLimit-Used: Number of requests sent against the current limit
• X-RateLimit-Expire: When the current limit will expire (Unix timestamp)
• X-RateLimit-Limit: Total number of requests allowed in the call limit
• X-RateLimit-Remaining: Number of requests allowed against the current limit

Here is an example of the response headers for a trade/quote call:

HTTP/1.1 200 OK
Content-Length: 6024
Content-Type: application/xml; charset=UTF-8
Date: Wed, 16 Mar 2011 14:51:44 GMT
Server: Apache-Coyote/1.1
X-RateLimit-Used: 8
X-RateLimit-Expire: 1300286940
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 52

Exceeding Limits

If you exceed these limits you will receive a rate limit fault along with the same rate limiting headers you would receive in the response. You will receive this as a response until the limit has expired, at which point you will receive regular responses.