API Reference
Authentication
Learn how to authenticate your requests to the API
The API uses API Keys for authenticating requests. You need to include your API key in every request to access the API endpoints.
Getting Your API Key
- Login or Sign up for an account by going over to the Dashboard.
- Navigate to the API Keys section from the top navigation bar.
- Create a new API key with a descriptive identifier (this is for you to remember what this key was for).
- Copy your API key and store it securely.
Security Best Practices for handling API Keys:
- Never expose your API Keys in public repositories.
- Store your API Key in environment variables.
- Rotate i.e. create new keys and delete old ones periodically to ensure your account is secure.
Using Your API Key
Include your API key in the x-api-key header of your HTTP requests:
x-api-key: YOUR_API_KEYExample Request
curl -H "x-api-key: YOUR_API_KEY" \
https://api.ipoalerts.in/ipos?status=openWhat happens if you don't provide a valid API Key?
If you do not include the key, you may receive a partial or an error response depending on the endpoint you're using. The table below summarizes the responses you should expect:
| Endpoint | Condition | Expected Response |
|---|---|---|
| Get All IPOs | API Key is not provided | Partial response limited to 1 IPO Object, along with the responseBody.meta.info containing the error message. |
| Incorrect API Key provided | 401 Unauthorized Error (ERR:INVLDKEY) | |
| Get One IPO | API Key is not provided | 401 Unauthorized Error (ERR:INVLDKEY) |
| Incorrect API Key provided | 401 Unauthorized Error (ERR:INVLDKEY) |
Limitations
The Free Plan allows you to create only 1 API Key. To have better organization and enforce security across multiple projects, upgrade to a paid plan which allows you to create unlimited API Keys.