Skip to main content
POST
/
instruments
Create Instrument
curl --request POST \
  --url https://api.{your-broker}.slate-labs.com/instruments \
  --header 'Content-Type: application/json' \
  --data '
{
  "symbol": "<string>",
  "display_name": "<string>",
  "category": "<string>",
  "base_currency": "<string>",
  "quote_currency": "<string>",
  "pip_size": 123,
  "margin_rate": 123,
  "unit_currency": "USD",
  "digits": 5,
  "contract_size": 100000,
  "min_lot": 0.01,
  "max_lot": 100,
  "lot_step": 0.01,
  "spread": 0,
  "swap_type": "pips",
  "swap_long": 0,
  "swap_short": 0,
  "stale_threshold_ms": 10000,
  "is_active": true,
  "asset_class": "other",
  "provider": "binance",
  "provider_symbol": "<string>"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "symbol": "<string>",
  "display_name": "<string>",
  "category": "<string>",
  "base_currency": "<string>",
  "quote_currency": "<string>",
  "unit_currency": "USD",
  "digits": 5,
  "pip_size": 123,
  "contract_size": 100000,
  "min_lot": 0.01,
  "max_lot": 100,
  "lot_step": 0.01,
  "margin_rate": 123,
  "spread": 0,
  "swap_type": "pips",
  "swap_long": 0,
  "swap_short": 0,
  "stale_threshold_ms": 10000,
  "is_active": true,
  "is_enabled": true,
  "asset_class": "other",
  "provider": "<string>",
  "provider_symbol": "<string>",
  "last_bid": 123,
  "last_ask": 123,
  "last_tick_at": "2023-11-07T05:31:56Z"
}

Body

application/json
​
symbol
string
required
Required string length: 1 - 32
​
display_name
string
required
Required string length: 1 - 64
​
category
string
required
Required string length: 1 - 32
​
base_currency
string
required
Required string length: 1 - 8
​
quote_currency
string
required
Required string length: 1 - 8
​
pip_size
number
required
​
margin_rate
number
required
​
unit_currency
string
default:USD
Maximum string length: 8
​
digits
integer
default:5
Required range: x >= 0
​
contract_size
integer
default:100000
Required range: x >= 1
​
min_lot
number
default:0.01
​
max_lot
number
default:100
​
lot_step
number
default:0.01
​
spread
number
default:0
Required range: x >= 0
​
swap_type
string
default:pips
​
swap_long
number
default:0
​
swap_short
number
default:0
​
stale_threshold_ms
integer
default:10000
Required range: x >= 1000
​
is_active
boolean
default:true
​
asset_class
string
default:other
Maximum string length: 32
​
provider
string
default:binance
Maximum string length: 32
​
provider_symbol
string | null
Maximum string length: 64

Response

Successful Response

​
id
string<uuid>
required
​
symbol
string
required
​
display_name
string | null
​
category
string | null
​
base_currency
string | null
​
quote_currency
string | null
​
unit_currency
string | null
default:USD
​
digits
integer | null
default:5
​
pip_size
number | null
​
contract_size
integer | null
default:100000
​
min_lot
number | null
default:0.01
​
max_lot
number | null
default:100
​
lot_step
number | null
default:0.01
​
margin_rate
number | null
​
spread
number | null
default:0
​
swap_type
string | null
default:pips
​
swap_long
number | null
default:0
​
swap_short
number | null
default:0
​
stale_threshold_ms
integer | null
default:10000
​
is_active
boolean | null
default:true
​
is_enabled
boolean
default:true
​
asset_class
string | null
default:other
​
provider
string | null
​
provider_symbol
string | null
​
last_bid
number | null
​
last_ask
number | null
​
last_tick_at
string<date-time> | null