Create Exchange

POST /exchanges

Creates a new exchange integration.

Required Permissions

NameConditions

Exchanges:Create

Always Required

Body

PropertyType / OptionalDescription

name*

String

A name for the Exchange.

kind*

String

The enumerated type for the exchange. Eg. Kraken

readConfiguration*

Object

Object containing the public and private API key pairs.

writeConfiguration*

Object

Object containing the public and private API key pairs.

Example

{
    "kind": "Binance",
    "name": "Binance 1",
    "readConfiguration": {
        "publicApiKey": "1234",
        "privateApiKey": "5678"
    },
    "writeConfiguration": {
        "publicApiKey": "1234",
        "privateApiKey": "5678"
    }
}

Response

Response example

{
  "id": "ex-lna4c-h5hr8-xxxxxxxxxxxxxxx",
  "name": "kraken",
  "kind": "Kraken",
  "dateCreated": "2024-09-12T15:14:14.107Z"
}

Last updated