instruments

Returns currencies and instruments available

POST api/instruments

Payload

{}

200 OK

[
    [
        [
            "USD",         // Currency name
            234525425,     // Currency id
            1000000,       // Balance step
            100000000,     // USD valuation
            'fiat',        // Currency type,
            ['SWIFT']      // List of available networks, not present in feed 'I' snapshot     
        ],
        [
            "BTC",
            345465767,
            1,
            1000000000000,
            'crypto',
            ['BTC', 'LN'] 
        ]
    ],
    [
        [
            "BTC-USD",     // Instrument name
            35462742745,   // Instrument id
            "BTC",         // Asset currency name
            "USD"          // Balance currency name
        ]
    ],
    [                       // Not present in feed 'I' snapshot 
        [
            "ERC20",        // Network name
            "Ethereum"      // Network description
            3               // Network id 
        ]
    ]      
]

400 Bad request

{
    "error": 2
}

Response description

Field name	Type	Description
	Array[3]	Array of 3 elements: currencies, instruments, and networks
0	Array of Currencies	Array of all currencies available
1	Array of Instruments	Array of all instruments available
2	Array of Networks	Array of all networks available (Field is not present for feed 'I' snapshot)
Currency	Array[5]
0	string	Currency name
1	unsigned int32	Currency Id
2	Efx::Size	Balance Step, minimum fraction of currency. From 1 to 1000000
3	Efx::Price	Current USD valuation for risk control
4	string	Currency Type Name
5	Array[string]	Array of network names available for that currency (Field is not present for feed 'I' snapshot)
Instrument	Array[4]
0	string	Instrument Name
1	unsigned int64	Instrument Id (used only in WebSocket Feed B as feedId)
2	string	Asset Currency Name
3	string	Balance Currency Name
Network	Array[3]
0	string	Network name
1	string	Network description
2	unsigned int32	Network ID