API Documentation
Docs you will love going back to.
The API Documentation is the central hub for all the APIs available on the Hub platform. Everytime you need to integrate a new API, you can refer to the documentation to understand the API’s capabilities and how to use it.
In the API Documentation you will find:
- Endpoints: The list of all the available endpoints and their schemas.
- Endpoint Details: A detailed description of each endpoint, including the request and response schemas.
- Endpoint Pricing: The pricing details for each endpoint, ie. the cost per call.
- Live Testing: A live testing environment where you can test the API endpoints with your own data.
- Code Snippets: Code snippets in multiple languages to help you integrate the API into your application.
We are always working on improving the API Documentation. If you have any feedback or suggestions, please let us know. Many more features regarding this coming soon 👀.
Find your way
The API Documentation is divided into 3 main sections:
- Endpoints Pane - The list of all the available endpoints.
- Endpoint Details - The detailed description of each endpoint.
- Live Testing - A live testing environment to test the API endpoints. Here you can also find code snippets in multiple languages.
Endpoints Pane
The Endpoints section, on the left most pane, lists all the available endpoints for the API you are interested in. You can click on an endpoint to view its details and test it in the live testing environment.
Endpoints are grouped by categories, making it easier to find the endpoint you are looking for.
Endpoint Details
The Endpoint Details section provides a detailed description of the selected endpoint. What is included here depends a lot on the API author. Genereally you can find the request and response schemas, as well as more information about the endpoint.
Live Testing
The Live Testing section is where you can test the API endpoints with your own data. You can also find code snippets in multiple languages to help you integrate the API into your application.
To test an endpoint, simply fill in the required fields and click on the “Send” button. You will need to provide your API key to make the call. This is to ensure that only authorized users can access the API.
Pricing
The Pricing section provides details about the cost of using the API. It can be found on the Pricing tab for each API.
Feedback
We want to create the best API Hub for developers like you. This is why we wake up everyday.
If you have any feedback or suggestions, please let us know here. We are always looking for ways to improve our platform and make it more useful for you.