API Documentation

Learn how to connect and integrate with our API.

 
Get your own API Key

Authentication

All the API requests require authentication through an API key sent via the Authorization header as shown below.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://instan.app/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

{
    "errors": [
        {
            "title": "api.error_message.no_access",
            "status": 401
        }
    ]
}
200 Request completed successfully
400 Bad request - Required parameters are missing or invalid
401 Unauthorized - API key is missing or invalid
404 The requested resource was not found
429 Too many requests - Rate limit exceeded
500 Internal server error - this means there is a problem on our end
All API endpoint results work with the Asia/Jakarta timezone unless specified otherwise.
User
Links
Links statistics
projects.title
Pixels
Splash pages
QR codes
Data
Custom domains
Account payments
Account logs