7.1. Return the user account details.
GET GetAccountDetails
Description: Returns detailed information about your user account.
API Usage: This endpoint uses zero API calls. Please refer to section 8.2 for more details on API rate limits.
GET Sample Request:
GET https://[server]/GetAccountDetails?SessionToken=YOUR_SESSION_TOKEN
| Parameter | Type | Description |
| SessionToken | String | The Session Token received from the GetSessionToken endpoint |
Response Parameters
| Parameter | Type | Mandatory | Description | |
|---|---|---|---|---|
| 1 | ServerDateTime | String | Yes | The server UTC date and time as an ISO 8601 string. |
| 2 | TimeStamp | Float | Yes | Server date and time as a Julian date. |
| 3 | ExecutionTime | Float | Yes | The number of milliseconds taken to process the request. |
| 4 | Result | [Object] | No* | A Result object as described in table below. |
| 5 | Errors | [Object] | No* | An 'Errors' object as described in table below. |
A successful API response will return a Result object with the requested payload or an 'Errors' object detailing the issue that caused the error.
Result Object
| Parameter | Type | Description | |
| 1 | UserNumber | String | The subscriber’s unique reference number. |
| 2 | Name | String | The subscriber’s full name. |
| 3 | Company | String | The subscriber’s company name. |
| 4 | Address1 | String | The first line of the registered address. |
| 5 | Address2 | String | The second line of the registered address. |
| 6 | City | String | The city of the registered address. |
| 7 | Country | String | The country of the registered address. |
| 8 | PostCode | String | Area, Zip or Postcode. |
| 9 | String | The subscribers registered email address ( used for password recovery). | |
| 10 | Registered | String | The date the subscriber first registered in YYYY-MM-DD format. |
| 11 | APIKey | String | The API key assigned to the account. |
| 11 | LastActiveTS | Float | The timestamp when the previous session token expired ( or user logged out) as a Julian date. |
| 11 | SimulatedData | Boolean | Is the price data returned by the API 'real' data or simulated (some demonstration accounts may use simulated) data. |
Errors Object
| Parameter | Type | Description | |
|---|---|---|---|
| 1 | Status | Integer | HTTP status code. |
| 2 | Detail | String | Description of the status code above. |
Possible Status codes in the 'Errors' object
| Code | Description |
|---|---|
| 400 | Missing parameter or unknown argument in request. |
| 401 | Invalid or unknown session token. |
| 403 | The account assigned to this email address is inactive. |
| 405 | Method [request] not allowed. |
| 410 | Session Token has expired. |
| 500 | Server may be down for maintenance. |
This is not an exhaustive list and additional error codes may be returned. The Errors object Detail field will return request specific error information.
Possible HTTP response codes
This endpoint returns 200 for
success.
You can get HTTP client network errors or server
errors from any API request. You should check
with your network or IT colleagues in case the issue is
a
local one.
All server generated errors will return an
'Errors'
object that will give specific details about the error.
A full list of HTTP codes and their meanings is
available here,
Success and fail examples
Sample Request:
GET https://[server]/GetAccountDetails?SessionToken=YOUR_SESSION_TOKEN