To make sure our Bank Account Data API is stable and its responses are prompt, we are introducing rate limits.
All of the following rate limits are on company level - calls from all credentials generated by one company's users count towards the limit.
The limits are as follows:
Endpoint | Limit |
GET /api/v2/accounts/{id}/ GET /api/v2/accounts/{id}/balances/ GET /api/v2/accounts/{id}/details/ GET /api/v2/accounts/{id}/transactions/ |
100 calls per minute (all calls are counted towards the same limit, regardless of whether they are for /balances, /details, or /transactions. This only applies to /accounts/ endpoints) |
GET /api/v2/institutions/ GET /api/v2/institutions/{id}/ |
300 calls per minute |
POST /api/v2/agreements/enduser/ POST /api/v2/requisitions/ |
100 calls per minute |
GET /api/v2/agreements/enduser/ GET /api/v2/agreements/enduser/{id}/ GET /api/v2/requisitions/ GET /api/v2/requisitions/{id}/ |
300 calls per minute |
PUT /api/v2/agreements/enduser/{id}/accept/ |
100 calls per minute |
DELETE /api/v2/agreements/enduser/{id}/ DELETE /api/v2/requisitions/{id}/ |
100 calls per minute |
POST /api/v2/token/new/ |
100 calls per hour |
POST /api/v2/token/refresh/ |
100 calls per minute |
Once the limit has been reached, the API will return the following error:
{ "summary": "Rate limit exceeded", "detail": "The rate limit for this resource is <times>/<time_period>. Please try again in <time_left> seconds", "status_code": 429 }
N.B.: Please note the differentiation between hitting our API rate limit and hitting the bank's rate limit. If it is the bank's limit, the error message will be as follows:
{ "summary": "Couldn't update <transactions> / <account details> / <balances>", "detail": "Daily request limit set by the Institution has been exceeded.", "type": "RateLimitError" }
Comments
0 comments
Please sign in to leave a comment.