Class MarketAPI

constructor

• new MarketAPI(apiClient): MarketAPI

• Parameters

  • apiClient: AxiosInstance

  Returns MarketAPI

price

Static Readonly URL

getMarketCategories

• getMarketCategories(nodeId?): Promise<MarketNavigation>

• Returns all nodes (market categories) in the market navigation hierarchy.

  Parameters

  • Optional nodeId: string

    The identifier of the node to browse

  Returns Promise<MarketNavigation>

  See

  • cache:https://labs.ig.com/rest-trading-api-reference/service-detail?id=550
  • cache:https://labs.ig.com/rest-trading-api-reference/service-detail?id=544

getMarketDetails

• getMarketDetails(epic): Promise<MarketDetail>

• Returns the details of the given market(s).

  Parameters

  • epic: string

    The epic of the market to be retrieved

  Returns Promise<MarketDetail>

  See

  cache:https://labs.ig.com/rest-trading-api-reference/service-detail?id=528

• getMarketDetails(epic): Promise<MarketDetails>

• Parameters

  • epic: string[]

  Returns Promise<MarketDetails>

searchMarkets

• searchMarkets(searchTerm): Promise<MarketSearch>

• Returns all markets matching the search term.

  Parameters

  • searchTerm: string

    The term to be used in the search

  Returns Promise<MarketSearch>

  See

  https://labs.ig.com/reference/markets-searchterm.html