In this guide, you’ll learn about total rate limits for Finch, rate limits for specific IP Addresses, and how to handle rate limit errors.
product
. Rate limits are summed on a rolling 60-second basis for each unique product
. This is commonly referred to as a Sliding or Rolling Window rate limit.
product
rate limit like a “bucket”. Therefore, when a request is made to a product
(which corresponds directly to an API endpoint), a single gallon of water is added to that endpoint’s bucket, thus starting that bucket’s 60-second time-to-live (TTL) timer.
After the product’s rate limit is reset after 60 seconds, the first request to that product
starts the 60-second TTL again.
product
manages a bucket simultaneously counting all requests across all access tokens created by that application. Multiple access tokens can be created from a single Finch application as more employers are connected. (A Finch application corresponds to a unique client_id
. You may have several client_id
s if you use a development or sandbox application in addition to production).
Product | Max requests initiated per minute |
---|---|
company | 20 |
directory | 20 |
individual | 20 |
employment | 20 |
pay-statement-item | 20 |
payment | 12 |
pay-groups | 12 |
pay-statement | 12 |
finch_code
: finch_application_rl in the response body.
max requests
are sent from the same IP Address within the duration
time set, a penalty
is enforced. No more requests are allowed once the penalty is enforced. Once the penalty duration is complete, requests will be accepted again.
Type | Max requests | Duration | Penalty |
---|---|---|---|
API | 1000 | 5 minutes | 60 minutes |
finch_code
: finch_api_ip_rl in the response body.