fetch_perpetual_instruments
Documentation for eth_defi.derive.api.fetch_perpetual_instruments function.
- fetch_perpetual_instruments(session, currency=None, base_url='https://api.lyra.finance', timeout=30.0)
Fetch all active perpetual instrument names from Derive.
Calls the public
get_all_instrumentsendpoint withinstrument_type="perp"to discover available perpetual contracts.Example:
from eth_defi.derive.api import fetch_perpetual_instruments from eth_defi.derive.session import create_derive_session session = create_derive_session() instruments = fetch_perpetual_instruments(session) # ['ETH-PERP', 'BTC-PERP', 'SOL-PERP', ...]
- Parameters
session (requests.sessions.Session) – HTTP session from
create_derive_session().currency (str | None) – Optional currency filter (e.g.
"ETH","BTC"). IfNone, returns all active perps.base_url (str) – Derive API base URL.
timeout (float) – HTTP request timeout in seconds.
- Returns
Sorted list of instrument names.
- Raises
ValueError – If the API returns an error response.
- Return type