Create Symbol

Create a tradable symbol.

trade_settings, margin_settings, and swap_settings are all required at creation time. Resolve the id fields first with GET /v1/symbol-types, GET /v1/industries, GET /v1/sectors, GET /v1/security-categories, and GET /v1/currencies.

session_profile_id decides when the symbol can be traded. Leaving it null means the market is treated as closed — see GET /v1/symbol-session-profiles.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

Symbol type id (see /v1/symbol-types)

string
required
length between 1 and 100
string
required
integer
required

see /v1/industries

integer
required

see /v1/sectors

integer
required

see /v1/security-categories

Universal (source) symbol name

integer
required
string
required
string
required
integer
required
integer
required
integer
required
integer
required
integer
required
integer
required
integer
required
integer
required
boolean
required
boolean
required
trade_settings
object
required
margin_settings
object
required
swap_settings
object
required

Row in /v1/symbol-session-profiles. NULL => market closed (fail-closed).

Responses

400

Validation error, or a referenced currency / category / profile does not exist

401

Invalid or missing API key

403

Access denied (credential scope)

429

Rate limit exceeded

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json