Interface MarketDataApiInterface

MarketDataApi - interface MarketDataApi

interface MarketDataApiInterface {
    getMarketDetail(
        requestParameters: GetMarketDetailRequest,
    ): Promise<RestApiResponse<GetMarketDetailResponse>>;
    listPredictionCategories(): Promise<
        RestApiResponse<ListPredictionCategoriesResponse>,
    >;
    listPredictionMarkets(
        requestParameters?: ListPredictionMarketsRequest,
    ): Promise<RestApiResponse<ListPredictionMarketsResponse>>;
    marketSearch(
        requestParameters: MarketSearchRequest,
    ): Promise<RestApiResponse<MarketSearchResponse>>;
    queryLastTradePrice(
        requestParameters: QueryLastTradePriceRequest,
    ): Promise<RestApiResponse<QueryLastTradePriceResponse>>;
    queryOrderBook(
        requestParameters: QueryOrderBookRequest,
    ): Promise<RestApiResponse<QueryOrderBookResponse>>;
}

Implemented by

W3WPredictionRestAPI.MarketDataApi

Index

Methods

getMarketDetail listPredictionCategories listPredictionMarkets marketSearch queryLastTradePrice queryOrderBook

Methods

getMarketDetail

getMarketDetail(
requestParameters: GetMarketDetailRequest,
): Promise<RestApiResponse<GetMarketDetailResponse>>
Get full details for a specific prediction market topic, including variant data and timeline.

Weight(IP): 200
Parameters
- requestParameters: GetMarketDetailRequest
  Request parameters.
Returns Promise<RestApiResponse<GetMarketDetailResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/market-data-api.ts:294

listPredictionCategories

listPredictionCategories(): Promise<
RestApiResponse<ListPredictionCategoriesResponse>,
>
Get all available prediction market categories (L1 and L2).

Weight(IP): 200

Returns Promise<RestApiResponse<ListPredictionCategoriesResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/market-data-api.ts:307

listPredictionMarkets

listPredictionMarkets(
requestParameters?: ListPredictionMarketsRequest,
): Promise<RestApiResponse<ListPredictionMarketsResponse>>
Get a paginated list of prediction market topics, with optional category and sort filters.

Weight(IP): 200
Parameters
- OptionalrequestParameters: ListPredictionMarketsRequest
  Request parameters.
Returns Promise<RestApiResponse<ListPredictionMarketsResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/market-data-api.ts:319

marketSearch

marketSearch(
requestParameters: MarketSearchRequest,
): Promise<RestApiResponse<MarketSearchResponse>>
Semantic search for prediction market topics by keyword.

Weight(IP): 200
Parameters
- requestParameters: MarketSearchRequest
  Request parameters.
Returns Promise<RestApiResponse<MarketSearchResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/market-data-api.ts:333

queryLastTradePrice

queryLastTradePrice(
requestParameters: QueryLastTradePriceRequest,
): Promise<RestApiResponse<QueryLastTradePriceResponse>>
Get the most recent trade price for a prediction market.

Weight(IP): 200
Parameters
- requestParameters: QueryLastTradePriceRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryLastTradePriceResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/market-data-api.ts:347

queryOrderBook

queryOrderBook(
requestParameters: QueryOrderBookRequest,
): Promise<RestApiResponse<QueryOrderBookResponse>>
Get the current order book (bids and asks) for a specific prediction market outcome token.

Weight(IP): 200
Parameters
- requestParameters: QueryOrderBookRequest
  Request parameters.
Returns Promise<RestApiResponse<QueryOrderBookResponse>>
Throws
Memberof
MarketDataApiInterface
- Defined in clients/w3w-prediction/src/rest-api/modules/market-data-api.ts:361