Skip to main content
GET
Quote

Overview

Simulate filling a single logical order across every routed venue that lists the outcome identified by predexonId. The router expands the supplied canonical predexon_id to every routed venue listing for that outcome, walks merged fee-inclusive order books, and returns the projected fill price, per-venue breakdown, and fill likelihood. No order is placed. Quote uses the same routing engine as Place Market Order, so a quote taken immediately before an order is a reliable preview of what the order will do. See the Order Router concept page for an end-to-end walkthrough of how the router decides which venues to route to.

Path Parameters

Query Parameters

Response Fields

Top level

Venue entry

Summary

Errors

Every error response includes a machine-readable errorCode alongside the human-readable error string.

Example

GET /api/accounts/acc_8f2e/router/quote?predexonId=px-uvtpjis2k7bj&side=buy&amount=10
The router ranks venues by effective price — i.e. the quoted price adjusted for each venue’s fee. A venue with a lower nominal bestPrice but a higher feeBpsAtTop can lose to a nominally worse venue with a thinner fee. feeBpsAtTop is price-aware, so different levels of the same book can surface different basis-point values.
venues[] lists only venues the router can actionably route to right now. Venues without a streaming book (infrastructure dropouts) are excluded from the response. The number of entries is therefore the count of routable venues for this outcome, not the size of the cross-venue equivalence set.

Authorizations

x-api-key
string
header
required

Trading key provided by Predexon. The data key used by the Sports Discovery API on api.predexon.com is a separate credential.

Path Parameters

accountId
string
required

Account ID. Must belong to the calling API key.

Query Parameters

predexonId
string
required

Canonical predexon_id for the outcome. The router expands this to every routed venue listing for that canonical outcome.

side
enum<string>
required

Order side.

Available options:
buy,
sell
amount
number<double>

USD/stablecoin notional to spend. Required when side=buy. Must not be set when side=sell.

size
number<double>

Number of shares to sell. Required when side=sell. Must not be set when side=buy.

Response

Quote simulated successfully.

predexonId
string
required

Echoes the request predexonId.

title
string
required

Human-readable outcome label (e.g. "Atlanta Hawks").

outcome
string
required

Canonical outcome code (e.g. "atl", "draw").

side
enum<string>
required
Available options:
buy,
sell
requestedAmount
string | null
required

Echo of the amount query parameter (stringified number). Present on buy quotes; null on sell quotes.

requestedSize
string | null
required

Echo of the size query parameter (stringified number). Present on sell quotes; null on buy quotes.

venues
object[]
required

One entry per actionable venue — venues the router cannot currently route to (no book, or a disconnected feed) are excluded from the array entirely.

summary
object | null
required

Aggregate projected fill. null when no venue could host any portion of the order.