Introduction
API basics
Our API provides tools for integrating our services as part of your own business. We provide an API for all needed actions for effectively managing your configuration and accessing data.
Accessing our API
Our API can be accessed using the following URL:
https://api.hypercell.ai
The alternative URL for the API is:
https://api.hypr.cl
Authentication
All requests to the API need to be authenticated using API credentials.
The API credentials, also known as a token, are passed along with the header of the request using a x-api-key variable.
Response
The API sends all responses in a JSON encoded format.
Example request
The following cURL example sends a request to fetch hourly data.
curl --request GET 'https://api.hypercell.ai/data/v7/hourly' \
--header 'x-api-key: [YOUR SECRET TOKEN]'
API methods
In general, our API uses the following methods.
| Method | Description |
|---|---|
| GET | Fetch data or resource(s) |
| POST | Create a resource |
| PATCH | Modify a resource |
| DELETE | Delete a resource |
API endpoints
Our API provides to different functionalities.
| API | Description |
|---|---|
| Data API | Provides access to data (read-only) |
| Management API | Used to manage resources (read/write) |
A detailed list of endpoints can be found in the API reference.