Test authentication
Confirm that your credentials work and see the account, permissions, and expiry associated with them.
This authenticated check returns your credential details without exposing any trading data.
How this call works
3 STEPSYour server
Send both credential headers
GET /pingCLIENT-KEY and CLIENT-SECRET on an HTTPS request. There is no token exchange and no session to establish first.
Cru
Cru identifies the credential
The hostname decides which market the credential is being used against, so a credential restricted to other markets is refused here too, with A009.
Your server
Check scopes and expiry before anything else
A 200 means the credential works. Read scopes to confirm it can do what your integration needs, and expires_at to find out whether it will still work next month.
KEEP
scopes, expires_at, organisation
Request parameters
This endpoint takes no query or body parameters. Include the two authentication headers with your request.
Response fields
200 OKFields returned in the data object.
pongboolean
Always true on success.
client_keystring
The client key that authenticated this call.
organisationstring
The account associated with the credential.
labelstring | null
Label chosen when the credential was issued.
scopesarray<string>
The scopes granted to this credential.
expires_atdatetime | null
Null when this credential does not expire.
server_timedatetime
Server time in RFC 3339 UTC.
Errors
Missing credentials return A001 / 401. Insufficient scope returns A003 / 403. View all error codes →