Connor Greig
Last updated: 15 September 2025
Welcome to our API documentation. This guide will assist you in obtaining an API key, understanding our usage limits, and effectively utilizing our available endpoints.
To access our API, you need to request an API key. This key is essential for authenticating your requests and ensuring that your interactions with our services are secure. Follow the steps below to obtain your API key:
Sign Up/Log In: Ensure you have an account with us. If not, please sign up.
Access API Settings: After logging in, navigate to the API section under your account settings.
Request Key: Click on the "Request API Key" button. You may need to provide additional information about your intended API usage.
Confirmation: You will receive a confirmation email once your request is reviewed and approved. Your API key will be displayed in your settings on the platform.
Understanding our usage limits is crucial to efficiently manage your interactions with the API. Here are the key points:
Rate Limits: Our API has a rate limit of 10 requests per minute. This limit ensures fair usage across all users.
Data Quotas: Each account is restricted to processing Y amount of data per month. Exceeding this limit may incur additional charges.
Error Handling: If you exceed the limits, the API will respond with a specific status code indicating the limit breach. Implement error handling in your application to manage such responses.
Our API offers various endpoints to interact with different services. Below are some guidelines to effectively use them:
Endpoint Structure: Our endpoints follow a RESTful design. Each endpoint is accessed via a specific URL pattern representing the resource you wish to interact with.
HTTP Methods: Use appropriate HTTP methods (GET) depending on the desired operation on the resource.
Authentication: Include your API key in the request header using the Authorization field to authenticate your requests.
Response Handling: Parse the JSON responses returned by the API to extract the necessary information. Ensure your application can handle different response statuses and error messages.
By adhering to this documentation, you will be well-equipped to utilize our API efficiently. For further details or support, please refer to our support page or contact our technical team.
