Account System
Account System API provides endpoints to retrieve information about the authenticated user account, including account balance, profile details, and subscription data.
Get account balance
GET https://api4.seranking.com/account/balance
Returns the current balance and currency information of the authenticated user account.
Request parameters
No parameters.
Request example
GET https://api4.seranking.com/account/balanceResponse parameters
If successful, the server returns the 200 HTTP status code and the account balance data.
| Parameter | Type | Description |
|---|---|---|
| currency | String | Account currency (deprecated; use currency_code instead). |
| currency_code | String | Account currency code (ISO 4217). |
| value | Float | Current account balance. |
Response example
{
"currency": "USD",
"currency_code": "USD",
"value": 99964.91699
}Get user profile
GET https://api4.seranking.com/account/profile
Returns profile information of the authenticated user account.
Request parameters
No parameters.
Request example
GET https://api4.seranking.com/account/profileResponse parameters
If successful, the server returns the 200 HTTP status code and the user profile data.
| Parameter | Type | Description |
|---|---|---|
| String | Account email. | |
| email_verified | Boolean | Email confirmation status (true – verified, false – not verified). |
| first_name | String | User’s first name. |
| last_name | String | User’s last name. |
| lang | String | Account language (ISO 639-1 alpha-2). |
| picture | String | Link to the user’s avatar (can be null). |
Response example
{
"email": "[email protected]",
"email_verified": true,
"first_name": "John",
"last_name": "Doe",
"lang": "en",
"picture": "https://online.seranking.com/files/public/avatar/se.png"
}Get subscription data
GET https://api4.seranking.com/account/subscription
Returns subscription information of the authenticated user account.
Request parameters
No parameters.
Request example
GET https://api4.seranking.com/account/subscriptionResponse parameters
If successful, the server returns the 200 HTTP status code and the subscription data.
| Parameter | Type | Description |
|---|---|---|
| type | String | Account type: manual (pay per check), trial, or subscription. |
| balance | Object | Account balance data for applicable account types. |
| is_expired | String | Indicates whether the license is expired. Applicable to trial and subscription types. |
The balance object has the following structure:
| Parameter | Type | Description |
|---|---|---|
| currency | String | Currency code (e.g., USD). |
| amount | Float | Account balance amount. |
Response example
{
"type": "subscription",
"is_expired": "false",
"balance": {
"currency": "USD",
"amount": 100.00
}
}