Skip to main content
POST
Create Instrument

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 | null
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
is_active
boolean | null
default:true
is_enabled
boolean
default:true
asset_class
string | null
default:other
exchange
string | null
provider
string | null
provider_symbol
string | null
last_bid
number | null
last_ask
number | null
last_tick_at
string<date-time> | null
logo_base_url
string | null
logo_quote_url
string | null
localized_description
string | null