API
Account & system
You are reading the Data API docs
baseurl:api.seranking.com Data API and Project API apikeys are not interchangeable. Use the correct apikey to avoid authentication errors.
Data apikey example:
80cfee7d-xxxx-xxxx-xxxx-fc8500816bb3 (UUID format)Project apikey example:
253a73adxxxxxxxxxxxxxx340aa0a939 (40-char hex)Get your apikeys in your account:
Questions or 401 errors? Email [email protected].
subscription
This command returns information on existing subscriptions along with the current API balance for the authenticated API key.
Request Parameters: subscription
| Parameter | Data Type | Mandatory | Default Value | Description | Acceptable values | Example |
|---|---|---|---|---|---|---|
| output | string | no | json | Output format | json, xml | json |
GET Request
To receive information about the subscription
curl -X GET 'https://api.seranking.com/v1/account/subscription?output=json' \
-H 'Authorization: Token YOUR_API_KEY'
Response Parameters: subscription
| Parameter | Data Type | Description | Example |
|---|---|---|---|
| status | string | Current status of the API subscription plan. One of: active, inactive, expired, disabled. | active |
| start_date | datetime | Subscription start date in “YYYY-MM-DD HH:MM:SS” format. | 2025-05-07 15:10:27 |
| expiration_date | datetime | Subscription expiration date in “YYYY-MM-DD HH:MM:SS” format. | 2026-05-07 15:10:27 |
| units_limit | long | Quota (total number of API units) for this subscription | 50000000 |
| units_left | long | Current API balance, i.e. number of API units left. | 123546 |
Sample Request: subscription
curl -X GET 'https://api.seranking.com/v1/account/subscription' \
-H 'Authorization: Token YOUR_API_KEY'
Sample Response: subscription
{
"subscription_info": {
"status": "active",
"start_date": "2024-01-18 14:20:02",
"expiraton_date": "2024-02-18 14:20:02",
"units_limit": 5000000,
"units_left": 4975033
}
}
