Reference
MIR API |
This comprehensive resource is designed to provide you with detailed information and guidance on utilizing the powerful capabilities of the MIR API. Whether you are a developer, administrator, or technical enthusiast, this reference page will help you understand and make the most of the API’s features.
The MIR API offers a flexible and efficient way to interact with your data, enabling you to perform a wide range of operations with ease. By utilizing this API, you can streamline your workflows, enhance your application’s functionality, and manage your data more effectively. This reference page is your go-to source for all the essential information you need to get started and excel with the MIR API.
Here, you will find detailed documentation on various aspects of the API, structured to help you navigate through the complexities and make the most of its features.
Rate Limits
To ensure fair usage and maintain optimal performance, the MIR API imposes rate limits on the number of requests you can make within a specified timeframe. Understanding and adhering to these limits is essential for maintaining the stability and reliability of your applications. Here’s what you need to know about rate limits:
1. Rate Limit Thresholds: Each API product has predefined rate limit thresholds, specifying the maximum number of requests allowed per minute, hour, or day. These thresholds help prevent abuse and ensure equitable access for all users.
2. Handling Rate Limit Exceeded Errors: If you exceed the allowed rate limit, the API will return a 429 Too Many Requests status code. When this happens:
• Backoff and Retry: Implement an exponential backoff strategy to wait before retrying your
requests. This involves progressively increasing the wait time between retries.
3. Subscription Plans: Different subscription plans may offer varying rate limits. Check your subscription details to understand the limits applicable to your account and consider upgrading if your application requires higher limits.
By understanding and managing your API usage within the rate limits, you can ensure smooth and uninterrupted access to the MIR API, providing a reliable experience for your application and its users.
Status and Error Codes
Understanding the status and error codes returned by the MIR API is crucial for effective error handling and troubleshooting. This section provides a comprehensive list of possible responses, including success and error codes, along with their meanings. By familiarizing yourself with these codes, you can quickly identify and resolve issues, ensuring a smooth and reliable user experience.
Success Codes
These codes indicate that your API requests have been successfully processed:
Error Code 200
The request was successful, and the server returned the requested data.
Error Code 201
The request was successful, and a new resource was created as a result.
Error Code 204
The request was successful, but there is no content to send in the response.
Client Error Codes
These codes indicate that there was an issue with the request sent by the client:
Error Code 400
Bad Request: The server could not understand the request due to invalid syntax. This often occurs when required parameters are missing or malformed.
Error Code 401
Unauthorized: The request requires user authentication. This error occurs when the API key or subscription key is missing or invalid.
Error Code 403
Forbidden: The server understood the request, but it refuses to authorize it. This can happen if the client does not have permission to access the requested resource.
Error Code 404
Not Found: The server could not find the requested resource. This is often due to an incorrect endpoint or resource ID.
Error Code 429
Too Many Requests: The client has sent too many requests in a given amount of time. This indicates that the rate limit has been exceeded.
Server Error Codes
These codes indicate that there was an issue on the server side:
Error Code 500
Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request. This is usually a temporary issue.
Error Code 502
Bad Gateway: The server received an invalid response from an inbound server it accessed while attempting to fulfill the request.
Error Code 503
Service Unavailable: The server is currently unable to handle the request due to temporary overloading or maintenance. This is usually a temporary state.
Error Code 504
Gateway Timeout: The server did not receive a timely response from an upstream server.
Error Codes
When an error occurs, the MIR API returns an errors object in the response. This object contains detailed information about what went wrong, helping you identify and fix issues more efficiently. The errors object typically includes message that is a human-readable description of the error.
{
“statusCode”: 401,
“message”: “Access denied due to invalid subscriptionkey. Make sure to provide a valid key for an active subscription.”
}
{
“statusCode”: 429,
“message”: “Rate limit is exceeded. Try again in 28 seconds.”
}
Patent Pending. Copyright © MIRLIN TECHNOLOGIES 2025. All rights reserved.
The information, designs and artwork contained in this document are confidential and may not be disseminated, distributed or copied without written consent from MIRLIN TECHNOLOGIES or its affiliate.