Add Orderly key

Limit: 10 requests per 1 second per IP address

POST /v1/orderly_key

Adds an orderly key to an account.

A main account’s orderly key can manage its sub accounts.

POST /v1/orderly_key

Add Orderly key

cURL

curl --request POST \
  --url https://api.orderly.org/v1/orderly_key \
  --header 'Content-Type: application/json' \
  --data '
{
  "message": {
    "brokerId": "<string>",
    "chainId": 123,
    "orderlyKey": "<string>",
    "scope": "<string>",
    "timestamp": 123,
    "expiration": 123,
    "chainType": "<string>",
    "tag": "<string>",
    "subAccountId": "<string>"
  },
  "signature": "<string>",
  "userAddress": "<string>"
}
'

200

{
  "success": true,
  "data": {
    "orderly_key": "ed25519:FRXntsPJBCy6dzKv9WPw4eYSw3rKU9Npz3T6UmvvJc9Z",
    "id": 123
  },
  "timestamp": 1702989203989
}

Body

application/json

message · object · required

Message object containing the message that is signed by the wallet owner

Show child attributes

signature · string · required

The signature generated by signing the message object via EIP-712

userAddress · string · required

The address of the wallet signing the message object via EIP-712

Response

200 - application/json

OK

success · boolean · required

Indicates whether the request was successful.

Example:

true

data · object · required

Show child attributes

timestamp · integer

Server timestamp in milliseconds.

Example:

1702989203989