We are introducing Rate Limit Headers for GoCardless Bank Account Data
Dear Customer,
We are reaching out to inform you of some important updates regarding our API that will enhance your experience and provide greater visibility into bank API rate limits.
Improvements in the API
As part of our effort to enhance transparency around API rate limits, we are implementing additional information in our API response - rate limit headers.
What are Rate Limit Headers?
Rate limit headers are response HTTP header fields included in API responses that will inform you about your current usage and remaining API call limits. These headers will offer you clearer insight into your rate limits for all API requests.
The new headers will provide key details such as the total request limit, the number of requests remaining within a specified timeframe, and the time until the limits reset.
The introduction of new API rate limit headers will include the following response headers:
General Rate Limits (for all API requests):
HTTP_X_RATELIMIT_LIMIT: Indicates the maximum number of allowed requests within the defined time window.
HTTP_X_RATELIMIT_REMAINING: Shows the number of remaining requests you can make in the current time window.
HTTP_X_RATELIMIT_RESET: Provides the time remaining in the current window.
Account Success Request (for account details, transactions, and balances):
HTTP_X_RATELIMIT_ACCOUNT_SUCCESS_LIMIT: Indicates the maximum number of allowed requests within the defined time window.
HTTP_X_RATELIMIT_ACCOUNT_SUCCESS_REMAINING: Shows the number of remaining requests you can make in the current time window.
HTTP_X_RATELIMIT_ACCOUNT_SUCCESS_RESET: Provides the time remaining in the current window.
How are these changes being made?
Starting from 19 August 2024, we will implement a limit of 10 API requests per day for each access scope (details, balances, transactions) on account id level as part of our ongoing efforts to enhance operational effectiveness and minimize potential issues for all our clients. This phased approach will allow us to optimize our services progressively.
We plan to establish a limit of four requests per day for each access scope in the next phase.
We will keep you informed and provide you with notice prior to the launch of the next phase, once we have finalized the timelines.
What does this mean for you?
From 19 August 2024, there will be a 10 requests per day limit. However, we advise you to begin adjusting your applications to accommodate the upcoming four requests per day limit.
Please note that failed requests against details, balances, and transactions endpoints will not count against the bank API rate limits, but they will count towards the general[ Bank Account Data API rate limits](https://gocardless.cmail19.com/t/t-l-sljtyx-tyjdhyukm-r/) Bank Account Data API rate limits.
As always, should you have any questions or require further assistance, please do not hesitate to reach out to our support team [here](https://gocardless.cmail19.com/t/t-l-sljtyx-tyjdhyukm-y/).
For further details, please refer to our updated help article on bank rate limits [here](https://gocardless.cmail19.com/t/t-l-sljtyx-tyjdhyukm-j/).
Thank you for your continued partnership.
Kind regards,
The GoCardless Bank Account Data team
We need to double check that we don't go over the limits.
We need to double check that we don't go over the limits.