Limitation

APIs are an essential component of modern software development, but they come with limitations that must be considered when building an application.

Rate limits

One of the key limitations is rate limiting, which restricts the number of API requests that can be made in a given time frame. For developers, it's important to understand the rate limiting rules for any API that you are using, as exceeding the limit can result in request errors and decreased performance.

Our API is limited to X requests per second. This number will depend on your needs and offer.

If you exceed this rate, you will receive a 429 HTTP status code. You will then have to wait until a given time period has elapsed to make additional requests.

You can check the response headers to get more detailed information:

Name
Retry-After
Type
Description
The remaining window before the rate limit resets, in UTC epoch seconds
Example: 1.898
Name
X-RateLimit-Limit
Type
Description
The maximum number of requests per second you are allowed to make
Example: 50
Name
X-RateLimit-Remaining
Type
Description
The number of requests remaining in the current rate limit window
Example: 49
Name
X-RateLimit-Reset
Type
Description
The time at which the current rate limit window resets
Example: Mon Jan 18 2021 11:41:08 GMT+0100

If you anticipate high traffic, we recommend that you contact us at business@bodyguard.ai

Scaling

The Bodyguard.ai API has been designed with scalability in mind, and features several mechanisms to ensure that it can meet the demands of even the largest and most complex applications.

HTTP/2

The Bodyguard.ai API supports HTTP/2, the latest version of the HTTP network protocol which offers numerous improvements over HTTP/1.1, including increased speed and efficiency through features such as binary format, multiplexing, and header compression.

This means that when using our API with an HTTP/2-enabled client, you can expect faster and more reliable transfers of data.

If you are unable to use HTTP/2, we recommend using keep-alive behavior. This can significantly improve the performance and efficiency when making a large number of HTTP requests. Keep-alive behavior involves reusing the same TCP connection for multiple requests, rather than establishing a new connection for each request.