wiki/exchanges/prediction/myriad.md
<a name="myriad" id="myriad"></a>
Kind: global class
Extends: <code>Exchange</code>
<a name="fetchMarkets" id="fetchmarkets"></a>
retrieves data on all markets for myriad, each prediction market becomes one market with its outcome tokens listed under the outcomes key
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - an array of objects representing market data
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra exchange-specific parameters |
| params.query | <code>string</code> | No | a single search term used to filter the fetched markets |
| params.queries | <code>Array<string></code> | No | multiple search terms (alternative to query) |
| params.state | <code>string</code> | No | 'open', 'closed' or 'resolved', the state of the markets to fetch, defaults to 'open' |
| params.limit | <code>int</code> | No | max number of markets to collect (defaults to options.fetchMarketsLimit, 1000); stops the pagination once reached |
myriad.fetchMarkets (params?)
<a name="fetchEvent" id="fetchevent"></a>
fetches a single prediction-market event by its market id
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction event structure
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | the market id |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchEvent (id, params?)
<a name="fetchPositions" id="fetchpositions"></a>
fetch the open outcome-token positions held by a wallet (myriad settles trades on-chain, so only read-only portfolio data is exposed by the API)
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction position structures
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| outcomes | <code>Array<string></code> | No | unified outcomes to filter by |
| params | <code>object</code> | No | extra exchange-specific parameters |
| params.address | <code>string</code> | No | the wallet address to query, defaults to this.walletAddress |
myriad.fetchPositions (outcomes?, params?)
<a name="fetchTradeQuote" id="fetchtradequote"></a>
fetches a trade quote — price, shares, fees and the on-chain calldata — for buying or selling an outcome. Myriad settles trades on-chain, so this returns the calldata to submit to the prediction-market contract rather than placing an off-chain order
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a quote object with price, shares, fees and the on-chain calldata
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome or outcome id |
| side | <code>string</code> | Yes | 'buy' or 'sell' |
| amount | <code>float</code> | Yes | for 'buy' the collateral value to spend; for 'sell' the number of shares to sell |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
| params.slippage | <code>float</code> | No | maximum slippage tolerance (default 0.005) |
myriad.fetchTradeQuote (outcome, side, amount, params?)
<a name="createOrder" id="createorder"></a>
create a trade order. Myriad has two trading models: a gasless order book (CLOB) where an EIP-712 signed order is posted off-chain and settled by the operator, and an on-chain AMM. Order-book markets are used by default; the model can be forced via params.tradingModel
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction order structure
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome or outcome id |
| type | <code>string</code> | Yes | 'limit' or 'market' (order book); ignored by the AMM path |
| side | <code>string</code> | Yes | 'buy' or 'sell' |
| amount | <code>float</code> | Yes | number of outcome shares to trade (AMM 'buy' spends this as collateral value instead) |
| price | <code>float</code> | No | price per share as a fraction in [0, 1] (required for order-book limit orders) |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
| params.tradingModel | <code>string</code> | No | 'ob' to force the order book, 'amm' to force the on-chain AMM; defaults to the market's model |
| params.timeInForce | <code>string</code> | No | order-book time in force: 'GTC', 'GTD', 'FOK', 'FAK' or 'PO' |
| params.expiration | <code>string</code> | No | unix-seconds expiration for a GTD order |
myriad.createOrder (outcome, type, side, amount, price?, params?)
<a name="createOrders" id="createorders"></a>
places multiple order book orders. Myriad's batch endpoint is not reliable, so the orders are signed and submitted sequentially (not atomically)
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction order structures
| Param | Type | Required | Description |
|---|---|---|---|
| orders | <code>Array<object></code> | Yes | a list of order requests, each with outcome, type, side, amount, price and params |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.createOrders (orders, params?)
<a name="editOrder" id="editorder"></a>
edits an open order by cancelling it and placing a replacement (gasless). Myriad's batch-modify endpoint is not reliable, so the cancel and replace are submitted sequentially
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction order structure
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | the hash of the order to replace |
| outcome | <code>string</code> | Yes | unified outcome of the new order |
| type | <code>string</code> | Yes | 'limit' or 'market' |
| side | <code>string</code> | Yes | 'buy' or 'sell' |
| amount | <code>float</code> | Yes | number of outcome shares for the new order |
| price | <code>float</code> | No | price per share as a fraction in [0, 1] |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.editOrder (id, outcome, type, side, amount, price?, params?)
<a name="createMarketBuyOrderWithCost" id="createmarketbuyorderwithcost"></a>
buys an outcome by spending a fixed collateral amount on the AMM (dollar-sizing)
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction order structure
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome handle |
| cost | <code>float</code> | Yes | the collateral (USDC) amount to spend |
| params | <code>object</code> | No | extra exchange-specific parameters |
myriad.createMarketBuyOrderWithCost (outcome, cost, params?)
<a name="cancelOrder" id="cancelorder"></a>
cancels an open order book order by its hash (re-signs the original order to prove ownership; gasless)
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction order structure
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | the order hash returned by createOrder |
| outcome | <code>string</code> | No | unified outcome the order belongs to |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.cancelOrder (id, outcome?, params?)
<a name="cancelAllOrders" id="cancelallorders"></a>
cancels all open order book orders for the wallet, optionally scoped to one market (gasless)
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - the raw response with the count of cancelled orders
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | No | unified outcome; when omitted cancels across all markets |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.cancelAllOrders (outcome?, params?)
<a name="cancelOrders" id="cancelorders"></a>
cancels multiple open order book orders by hash in one request (gasless)
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction order structures
| Param | Type | Required | Description |
|---|---|---|---|
| ids | <code>Array<string></code> | Yes | the order hashes to cancel |
| outcome | <code>string</code> | No | not used by myriad cancelOrders |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.cancelOrders (ids, outcome?, params?)
<a name="fetchOrder" id="fetchorder"></a>
fetches a single order book order by its hash
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction order structure
| Param | Type | Required | Description |
|---|---|---|---|
| id | <code>string</code> | Yes | the order hash |
| outcome | <code>string</code> | No | unified outcome the order belongs to |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchOrder (id, outcome?, params?)
<a name="fetchOrders" id="fetchorders"></a>
fetches order book orders for the wallet (or any trader passed via params.trader)
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction order structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | No | unified outcome to filter by |
| since | <code>int</code> | No | timestamp in ms of the earliest order |
| limit | <code>int</code> | No | the maximum number of orders to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
| params.trader | <code>string</code> | No | wallet address to query (defaults to the configured wallet) |
| params.status | <code>string</code> | No | 'open', 'filled', 'cancelled' or 'expired' |
myriad.fetchOrders (outcome?, since?, limit?, params?)
<a name="fetchOpenOrders" id="fetchopenorders"></a>
fetches open order book orders for the wallet
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction order structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | No | unified outcome to filter by |
| since | <code>int</code> | No | timestamp in ms of the earliest order |
| limit | <code>int</code> | No | the maximum number of orders to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchOpenOrders (outcome?, since?, limit?, params?)
<a name="fetchClosedOrders" id="fetchclosedorders"></a>
fetches the wallet's filled order book orders
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction order structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | No | unified outcome to filter by |
| since | <code>int</code> | No | timestamp in ms of the earliest order |
| limit | <code>int</code> | No | the maximum number of orders to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchClosedOrders (outcome?, since?, limit?, params?)
<a name="fetchCanceledOrders" id="fetchcanceledorders"></a>
fetches the wallet's cancelled order book orders
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction order structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | No | unified outcome to filter by |
| since | <code>int</code> | No | timestamp in ms of the earliest order |
| limit | <code>int</code> | No | the maximum number of orders to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchCanceledOrders (outcome?, since?, limit?, params?)
<a name="fetchMyTrades" id="fetchmytrades"></a>
fetches the wallet's filled order book orders as trades. Note: Myriad's REST exposes the order's limit price, not the per-fill execution price, so the price reflects the order's limit (exact for resting/limit fills, an upper/lower bound for market orders) — use watchTrades for live execution prices
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction trade structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | No | unified outcome to filter by |
| since | <code>int</code> | No | timestamp in ms of the earliest trade |
| limit | <code>int</code> | No | the maximum number of trades to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchMyTrades (outcome?, since?, limit?, params?)
<a name="fetchBalance" id="fetchbalance"></a>
fetches the wallet's on-chain collateral balance for the order-book network (USD1 on BNB Chain)
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a balance structure
See: https://docs.myriad.markets/builders/myriad-order-book/order-book-api
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
| params.network_id | <code>string</code> | No | the network id (defaults to options.defaultNetworkId, '56') |
myriad.fetchBalance (params?)
<a name="fetchTicker" id="fetchticker"></a>
fetches the current price for a single outcome by loading the parent market
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction ticker structure
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome like TRUMP_WIN:YES or an outcome id like 2741:756/0 |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchTicker (outcome, params?)
<a name="fetchTradingFee" id="fetchtradingfee"></a>
fetches the buy/sell fee rates for a market outcome
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a fee structure
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome or outcome id |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchTradingFee (outcome, params?)
<a name="fetchOrderBook" id="fetchorderbook"></a>
fetches the real order book for order-book markets, or synthesizes a one-level book from the AMM price otherwise
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction order book structure
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome like TRUMP_WIN:YES or an outcome id |
| limit | <code>int</code> | No | not used by myriad fetchOrderBook |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchOrderBook (outcome, limit?, params?)
<a name="fetchOHLCV" id="fetchohlcv"></a>
fetches price history for an outcome from the price_charts bucket embedded in the market response
Kind: instance method of <code>myriad</code>
Returns: <code>Array<Array<int>></code> - a list of candles ordered as timestamp, open, high, low, close, volume
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome like TRUMP_WIN:YES or an outcome id |
| timeframe | <code>string</code> | Yes | mapped to the closest available chart bucket (24h, 7d or 30d) |
| since | <code>int</code> | No | timestamp in ms of the earliest candle to fetch |
| limit | <code>int</code> | No | the maximum number of candles to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchOHLCV (outcome, timeframe, since?, limit?, params?)
<a name="fetchTickers" id="fetchtickers"></a>
fetches tickers for multiple outcomes, grouping requested outcomes by their parent market to fetch each market only once
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a dictionary of prediction ticker structures indexed by outcome
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| outcomes | <code>Array<string></code> | Yes | unified outcomes — required: myriad has no endpoint returning all tickers at once, so an unscoped call is not supported |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchTickers (outcomes, params?)
<a name="fetchTrades" id="fetchtrades"></a>
fetches recent public trades for a single outcome from the market action feed
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction trade structures
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome like TRUMP_WIN:YES or an outcome id |
| since | <code>int</code> | No | timestamp in ms of the earliest trade to fetch |
| limit | <code>int</code> | No | the maximum number of trades to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.fetchTrades (outcome, since?, limit?, params?)
<a name="fetchEvents" id="fetchevents"></a>
fetches prediction-market events matching the given scope (query/queries/tags/eventId — required) and caches their markets and outcomes on the instance
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - an array of event structures
See: https://docs.myriad.markets/builders/myriad-api-reference
| Param | Type | Required | Description |
|---|---|---|---|
| params | <code>object</code> | No | extra exchange-specific parameters |
| params.query | <code>string</code> | No | a single search term; an eventId does a direct lookup and tags map to server-side keyword searches |
| params.queries | <code>Array<string></code> | No | multiple search terms (alternative to query) |
| params.tags | <code>Array<string></code> | No | tag slugs to scope by (searched as keywords, e.g. ['bitcoin', 'world-cup']) |
| params.eventId | <code>string</code> | No | direct lookup by unified event id (composite networkId:marketId) |
| params.limit | <code>int</code> | No | maximum number of markets per query, defaults to 50 |
| params.state | <code>string</code> | No | 'open', 'closed' or 'resolved', defaults to 'open' |
myriad.fetchEvents (params?)
<a name="watchOrderBook" id="watchorderbook"></a>
streams the order book for an outcome over the Centrifugo websocket; the channel is delta-only so the book is seeded from the REST snapshot
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction order book structure
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome |
| limit | <code>int</code> | No | the maximum number of order book entries to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchOrderBook (outcome, limit?, params?)
<a name="watchTrades" id="watchtrades"></a>
streams public trades for an outcome over the Centrifugo websocket
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction trade structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome |
| since | <code>int</code> | No | timestamp in ms of the earliest trade |
| limit | <code>int</code> | No | the maximum number of trades to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchTrades (outcome, since?, limit?, params?)
<a name="watchMyTrades" id="watchmytrades"></a>
streams the wallet's own fills for a market over the Centrifugo trades channel (real execution prices, unlike the REST fetchMyTrades); requires a market outcome since the channel is per-market
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction trade structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome whose market to watch |
| since | <code>int</code> | No | timestamp in ms of the earliest trade |
| limit | <code>int</code> | No | the maximum number of trades to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchMyTrades (outcome, since?, limit?, params?)
<a name="watchTicker" id="watchticker"></a>
streams best bid/ask/last for an outcome over the Centrifugo prices channel
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a prediction ticker structure
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchTicker (outcome, params?)
<a name="watchTickers" id="watchtickers"></a>
streams best bid/ask/last for several outcomes over the Centrifugo prices channels
Kind: instance method of <code>myriad</code>
Returns: <code>object</code> - a dict of prediction ticker structures indexed by outcome
| Param | Type | Required | Description |
|---|---|---|---|
| outcomes | <code>Array<string></code> | Yes | unified outcomes to watch |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchTickers (outcomes, params?)
<a name="watchOHLCV" id="watchohlcv"></a>
streams OHLCV candles for an outcome, synthesised from the live trades channel
Kind: instance method of <code>myriad</code>
Returns: <code>Array<Array<int>></code> - a list of [timestamp, open, high, low, close, volume] candles
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | Yes | unified outcome |
| timeframe | <code>string</code> | Yes | the length of each candle (e.g. '1m', '1h', '1d') |
| since | <code>int</code> | No | timestamp in ms of the earliest candle |
| limit | <code>int</code> | No | the maximum number of candles to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchOHLCV (outcome, timeframe, since?, limit?, params?)
<a name="watchOrders" id="watchorders"></a>
streams the wallet's order lifecycle updates over the Centrifugo orders channel
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction order structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcome | <code>string</code> | No | unified outcome to filter by |
| since | <code>int</code> | No | timestamp in ms of the earliest order |
| limit | <code>int</code> | No | the maximum number of orders to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchOrders (outcome?, since?, limit?, params?)
<a name="watchPositions" id="watchpositions"></a>
streams the wallet's share-balance changes over the Centrifugo positions channel
Kind: instance method of <code>myriad</code>
Returns: <code>Array<object></code> - a list of prediction position structures
| Param | Type | Required | Description |
|---|---|---|---|
| outcomes | <code>Array<string></code> | No | unified outcomes to filter by |
| since | <code>int</code> | No | timestamp in ms of the earliest position update |
| limit | <code>int</code> | No | the maximum number of position updates to return |
| params | <code>object</code> | No | extra parameters specific to the exchange API endpoint |
myriad.watchPositions (outcomes?, since?, limit?, params?)