Skip to main content
GET
/
v1
/
client
/
key_info
Get current Orderly key info
curl --request GET \
  --url https://api.orderly.org/v1/client/key_info \
  --header 'orderly-account-id: <orderly-account-id>' \
  --header 'orderly-key: <orderly-key>' \
  --header 'orderly-signature: <orderly-signature>' \
  --header 'orderly-timestamp: <orderly-timestamp>'
{
  "success": true,
  "data": {
    "rows": [
      {
        "orderly_key": "ed25519:B4yEc8xMjoqdUiKT5ZT1b2cUy5cggZrbMPvCrqyjkQhf",
        "key_status": "ACTIVE",
        "ip_restriction_list": [
          "<string>"
        ],
        "ip_restriction_status": "ALLOW_ALL_IPS",
        "expiration": 1689086651947,
        "scope": "read,trading",
        "tag": "<string>"
      }
    ]
  },
  "timestamp": 1702989203989
}

Headers

​
orderly-timestamp
string
required

Timestamp of the signed request in milliseconds.

​
orderly-account-id
string
required

Account ID of the authenticated account.

​
orderly-key
string
required

Public orderly key used to sign the request.

​
orderly-signature
string
required

Signature of the request payload generated with the orderly key.

Query Parameters

​
key_status
string

Filter by orderly key status. Supported values: ACTIVE, REMOVING, or REMOVED.

Response

200 - application/json

OK

​
success
boolean
required

Indicates whether the request was successful.

Example:

true

​
data
object
required
​
timestamp
integer

Server timestamp in milliseconds.

Example:

1702989203989