Links

SYMBOLS

Clients can retrieve existing symbols and create new symbols
GET SYMBOLS
Sample request examples:
{“type”:”getsymbols”}
{“result”:”OK”,”data”:[{“pair”:false,”tradingsymbol”:false,”security”:
“USD”,”fractionbase”:100},{“pair”:false,”tradingsymbol”:false,”security”:”GROUP1
6”,”fractionbase”:1},{“pair”:false,”tradingsymbol”:false,”security”:”ETH”,”fract
ionbase”:10000},{“pair”:false,”tradingsymbol”:false,”security”:”COIN”,”fractionb
ase”:10},{“pair”:false,”tradingsymbol”:false,”security”:”CAD”,”fractionbase”:100
},{“pair_second”:”USD”,”pair”:true,”pair_first”:”BTC”,”tradingsymbol”:true,”secu
rity”:”BTCUSD”,”fractionbase”:1000000},{“pair_second”:”USD”,”pair”:true,”pair_fi
rst”:”BTCT”,”tradingsymbol”:true,”security”:”BTCTUSD”,”fractionbase”:1000000},{“
pair”:false,”tradingsymbol”:false,”security”:”BTCETH”,”fractionbase”:100000},{“p
air”:false,”tradingsymbol”:false,”security”:”BTC”,”fractionbase”:1000000}],”type
“:”getsymbols”}
This returns list of symbols defined in backend.
In your request, you can optionally set “security” for symbol and system will only return that symbol definition back to you. You can also set “tradingsymbolonly” to “Y” and system will return a list of permitted trading symbols back to you.
  • fractionbase” means how many decimal points precisions that system support, 1000 means for this instrument, system support decimal point up to 0.001
  • “pair”, true/false, if symbol is a crypto pair, it is true, also, symbol will set “pair_first” and “pair_second” value to tell you which corresponding instruments are in this trading pair.
  • “tradingsymbol”, true/false, if symbol is a tradable symbol.
  • “fiat”, true/false, if symbol is crypto pair and has fiat in it or symbol itself is fiat.
SYMBOL REGISTRATION
SYMBOL REGISTRATION MESSAGE
  • “registersymbol”, only super user can use this command.
  • “security”, symbol, required, such as BTCUSD
  • “description”, optional, description of what this instrument is.
  • “fractionbase”, optional, 10000 mean 0.0001 minimum fraction
  • “pairseppos”, optional, specify crypto pair’s separation position for BTCUSD is 3
  • “istradingsymbol”, Boolean, optional, indicates if this is a trading instrument, default is set to no
    • For example, “BTCUSD” should be a trading instrument, “BTC”, however, is not.
  • “priceprecision”, optional, specify the price precision, 100 for 0.01
  • minipriceincr”, optional, minimum price increment, in combined with priceprecision
    • For example, 5 for “minipriceincr” and 100 for “priceprecision” means minimum increment is
  • “isfiat”, Boolean, optional, indicates if this is a fiat based instrument, default is no
  • "clearinginstrument”, optional, indicate underlying clearing instrument
  • “commissioninstrument”, optional, indicate underlying commission instrument.
  • “comm”, optional, indicates underlying commission rate, 5 means 5%. “external precision”, optional, specify external custodian (such as Bitgo) precision
SAMPLE REQUEST SYMBOL REGISTRATION
{"type":"registersymbol","security":"WS001","description":"test symbol ws
01","fractionbase":"100","istradingsymbol":true}
SAMPLE RESPONSE SYMBOL REGISTRATION
{"result":"OK","security":"WS001","fractionbase":"100","description":"test symbol ws
01","type":"registersymbol","istradingsymbol":true}
Last modified 2yr ago