API Description
Account
Account balance
The method allows to check the balance of a user account.
Request format
| GET /account/balance |
Result
If successful, the server returns an array containing the account currency, currency code and current account balance.
| Name | Required | Description |
| currency | Yes | Account currency (outdated, use currency_code instead) |
| currency_code | Yes | Account currency code |
| value | Yes | Current account balance |
Response example
| { “currency”: “USD”, “currency_code”: “USD”, “value”: 99964.91699 } |
User profile
The method allows you to get information about the currently logged in user.
Request format
| GET /account/profile |
Result
If successful, the server returns an array containing account data.
| Name | Required | Type | Description |
| Yes | String | Account email | |
| email_verified | Yes | Bool | Email confirmed (1 – yes, 2 – no) |
| first_name | Yes | String | Account name |
| last_name | Yes | String | Account surname |
| lang | Yes | String | Account language (ISO 639-1 alpha-2) |
| picture | Yes | String|null | Link to the user’s avatar. Null if missing |
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”} |
Subscription data
The method allows you to get information about the currently logged in user’s subscription.
Request format
| GET /account/subscription |
Result
If successful, the server returns an array containing subscription data.
| Name | Required | Type | Description |
| type | Yes | String | manual (pay for checks) | trial (trial account) | subscription |
| balance | No | Array | {‘currency’ => Currency code (USD | RUB)‘amount’ => Account balance} |
| is_expired | No | Boolean | true if the license is expired.Only for type=trial and type=subscription |
Response example
| { “type”: “subscription”, “is_expired”: “false”, “balance”: { “currency”: “USD”, “amount”: 100.00 }} |