Instruments
List instruments
List instruments
get/instruments
Query parameters
trading_status'ACTIVE' | 'INACTIVE'
Instrument trading status
- ACTIVE - The instrument can currently be traded on the Upvest platform.
- INACTIVE - The instrument cannot currently be traded on the Upvest platform.
Filters the list to only show instruments with a certain status (e.g. only instruments that can be currently traded).
sort'created_at' | 'updated_at'
Sort the result by created_at or updated_at.
order'ASC' | 'DESC'
Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.
offsetinteger
Use the offset argument to specify where in the list of results to start when returning items for a particular query.
limitinteger
Use the limit argument to specify the maximum number of items returned.
Response
OK