Expand description
Resource methods for the instruments API group.
§Operations
| Method | Op | Path |
|---|---|---|
| GET | lookup | /instruments/lookup/{lookup_type}/{lookup} |
| GET | list_types | /instruments/types |
| GET | get_type | /instruments/types/{instrument_type} |
| GET | list_underlyings | /instruments/underlyings/{derivative_type}/{currency} |
| GET | get_instrument_suitability | /instruments/validation/suitability/{instrument_id} |
| GET | get_instrument | /instruments/{instrument_id} |
| GET | list_leverages | /instruments/{instrument_id}/leverages |
| GET | get_leverage_filters | /instruments/{instrument_id}/leverages/filters |
| GET | list_instrument_trades | /instruments/{instrument_id}/trades |
§Naming
Two ops are renamed from their docs name so they can co-exist on
Client alongside same-named ops in other groups (Rust resolves all
resource methods onto a single Client impl):
list_trades->list_instrument_trades— to coexist withtradables::list_tradable_tradesand the futureaccounts::list_trades.get_suitability->get_instrument_suitability— to coexist withtradables::get_suitability.
Phase 3X may pick a uniform naming scheme.
§204 No Content
All ops except list_types and get_leverage_filters document a 204
response. The base Client::get surfaces an empty body as a
Error::Decode; each method here maps that case to an empty Vec
(mirroring the tradables precedent). get_leverage_filters returns a
single LeverageFilter (no array shape) so 204 is not mapped.
Structs§
- Leverages
Query - Optional query parameters for
Client::list_leveragesandClient::get_leverage_filters.