@qtsurfer/api-client
    Preparing search index...

    Type Alias Exchange

    Exchange service provider

    type Exchange = {
        description?: string;
        id: string;
        liveSegments: string[];
        name: string;
        segments: string[];
        venueType: "cex" | "dex";
    }
    Index
    description? id liveSegments name segments venueType
    description?: string

    Description of the exchange

    id: string

    Unique identifier for the exchange

    liveSegments: string[]

    The segments among segments for which live data is published, so the ones a live run can read: a live run on any other segment of the exchange is refused with 400. It can be empty (an exchange whose live data is not published yet).

    name: string

    Name of the exchange

    segments: string[]

    The segments the exchange offers, written as in the path of GET /exchange/{exchangeId}/{segment}/instruments and as the segment of a live run's source. For a cex exchange, its market segments (spot, futures: the ones its instrument catalogues are served under); for a dex exchange, the protocols whose pools a run can read.

    venueType: "cex" | "dex"

    Venue category, written as the venueType of a live run's source: cex is a centralized exchange and dex a decentralized one. A dex exchange has no market data to prepare or backtest, so its id is not valid in the routes that take an exchangeId, except the two instruments routes, which list its pools (the instrument of a run on it is a pool's address).

    Settings
    Member Visibility

    On This Page
    Properties