Skip to main content
POST
Reads a price feed once and returns the price it would give, converted into the book’s settlement currency where that applies. Nothing is saved. Use it to check a stock ticker, a commodity unit or a custom feed before you set it with priceFeed on Create Order Book or Update Order Book. See Price feed module. The settlement currency comes from orderBookId when you name a book, or from quoteTokenAddress before a book exists. With neither, the price comes back in the feed’s own currency. A USD feed on a book that settles in a USD stablecoin such as USDC is not converted. A custom feed is never converted and comes back with currency null, because its currency is not known: it is used as it quotes.

Body Parameters

object
required
The feed to read, in the same shape as on Create Order Book.
string
A book you own or have imported. Its settlement currency is used.
string
The settlement asset of a book you are about to create. Its currency is used.

Response Fields

object

Error Codes