/session/refresh-token

POST (version: 1)

Refreshes a trading session, obtaining new session tokens for subsequent API access.
Request
Parameter Type Name Description
Body request (Object)
Refresh session request
refresh_token (String) Refresh token
[Constraint: NotNull]
Response
Access token response
access_token (String) Access token
expires_in (String) Access token expiry in seconds
refresh_token (String) Refresh token
scope (String) Scope of the access token
token_type (String) Token type
Exceptions
HTTP code Description
400
error.public-api.failure.encryption.required A login has been attempted to the login V1 service by a client from the IG Singapore company. They need to use the v2 version as they need to send their passwords encrypyted.
400
error.request.invalid.date-range Invalid date range
400
error.security.api-key-missing The api key was not provided
400
invalid.input A generic input data error has occurred
401
authentication.failure.not-a-client-account The account is not a valid client account
401
error.public-api.failure.kyc.required The account is not allowed to log into public API. Please use the web platform.
401
error.public-api.failure.missing.credentials The user has not provided all required security credentials.
401
error.public-api.failure.pending.agreements.required The account is not allowed to log into public API. Please use the web platform.
401
error.public-api.failure.preferred.account.disabled The user's preferred account is disabled.
401
error.public-api.failure.preferred.account.not.set The user has not set a preferred account.
401
error.security.account-access-denied The account has been denied login privileges
401
error.security.account-migrated The account has been migrated to the client-account model, please authenticate with the client credentials
401
error.security.account-not-yet-activated The account has not been activated yet
401
error.security.account-suspended The account has been suspended
401
error.security.account-token-invalid The service requires an account token and the one provided was not valid
401
error.security.account-token-missing The service requires an account token and it was not provided
401
error.security.all-accounts-pending All of the accounts are in a pending state
401
error.security.all-accounts-suspended All of the clients accounts have been suspended
401
error.security.client-suspended The client has been suspended from using the platform
401
error.security.client-token-invalid The service requires a client token and the one provided was not valid
401
error.security.client-token-missing The service requires a client token and it was not provided
401
error.security.generic An unexpected error has been encountered on the server side, cannot proceed. Please contact the support.
401
error.security.invalid-application The provided user agent string is not valid
401
error.security.invalid-details The credentials used to authenticate the users are not valid, login is rejected
401
error.security.invalid-details The credentials used to authenticate the users are not valid, login is rejected
401
error.security.invalid-website This site is not accessible via the API services
401
error.security.oauth-token-invalid Invalid OAuth access token
401
error.security.too-many-failed-attempts Maximum number of failed login attempts have been reached
403
endpoint.unavailable.for.api-key The provided api key was not accepted
403
error.public-api.exceeded-account-allowance The account traffic allowance has been exceeded
403
error.public-api.exceeded-account-historical-data-allowance The account historical data traffic allowance has been exceeded
403
error.public-api.exceeded-account-trading-allowance The account trading traffic allowance has been exceeded
403
error.public-api.exceeded-api-key-allowance The api key traffic allowance has been exceeded
403
error.public-api.failure.stockbroking-not-supported Stockbroking not supported for Public API users.
403
error.security.api-key-disabled The provided api key was not accepted because it is not currently enabled
403
error.security.api-key-invalid The provided api key was not accepted
403
error.security.api-key-restricted The provided api key was not valid for the requesting account
403
error.security.api-key-revoked The provided api key was not accepted because it has been revoked
404
invalid.url
500
system.error
504
error.security.authentication.timeout Authentication time-out

Uncaught exception thrown in shutdown function.

PDOException: SQLSTATE[25006]: Read only sql transaction: 7 ERROR: cannot execute DELETE in a read-only transaction: DELETE FROM {semaphore} WHERE (value = :db_condition_placeholder_0) ; Array ( [:db_condition_placeholder_0] => 558106530610b46e11ab7d4.55323620 ) in lock_release_all() (line 269 of /var/ig/webcontent/drupal/includes/lock.inc).