Compute order route
Computes a fill quote across available venues for a specific venue market outcome and returns the suggested fills.
GET
Computes a fill quote across available venues for a specific venue market outcome and returns the suggested fills. When a user JWT is supplied the quote is scoped to the user's wallet balances and may be executed; without a JWT the response is a preview-only quote.
Loading code example
Loading code example
Authorizations
appIdstringheaderrequired
API key passed in the header.
Path Parameters
venueMarketOutcomeIdstringrequired
Query Parameters
mode"live" | "paper"
Allowed values:
"live" | "paper"chainBalancesstring
slipCapBpsnumber
Required range:
x >= 0maxSpendnumber
Required range:
x >= 0sellSharesnumber
Required range:
x >= 0compareVenues"true" | "false"
Allowed values:
"true" | "false"allowedVenuesany
side"buy" | "sell"
Allowed values:
"buy" | "sell"deepEstimate"true" | "false"
Allowed values:
"true" | "false"Response
application/json
200
quoteIdstringrequiredvenueMarketOutcomeIdstringrequiredvenueMarketIdstringrequiredestimatedCostRawstringrequiredexpiresAtstringrequiredrefreshAtstringrequiredstatus"ok" | "infeasible" | "checker_rejected" | "solver_error" | "invalid_input" | "no_orderbooks" | "insufficient_input_amount" | "engine_unavailable" | "min_order_size_violated" | "insufficient_balance" | "insufficient_position" | "insufficient_depth" | "no_bids_above_min_price"requiredAllowed values:
"ok" | "infeasible" | "checker_rejected" | "solver_error" | "invalid_input" | "no_orderbooks" | "insufficient_input_amount" | "engine_unavailable" | "min_order_size_violated" | "insufficient_balance" | "insufficient_position" | "insufficient_depth" | "no_bids_above_min_price"fillsarray<object>requiredfills.venuestringrequiredfills.venueMarketIdstringrequiredfills.venueMarketOutcomeIdstringrequiredfills.chainstringrequiredfills.avgPricenumberrequiredfills.yesPricenumberrequiredfills.noPricenumberrequiredfills.fillsarray<object>requiredfills.venueQtynumberrequiredfills.venueFeenumbertotalFillednumberrequiredrawExecCostnumberrequiredsolveTimeMsnumberrequiredverifyTimeMsnumberrequiredmatchedMarketsarray<object>requiredmatchedMarkets.venuestringrequiredmatchedMarkets.venueMarketIdstringrequirederrorstringvenueSoloQuotesarray<object>venueSoloQuotes.quoteIdstringrequiredvenueSoloQuotes.venuestringrequiredvenueSoloQuotes.avgPricenumberrequiredvenueSoloQuotes.filledQtynumberrequiredvenueSoloQuotes.rawExecCostnumberrequiredvenueSoloQuotes.estimatedPayoutnumberrequiredvenueSoloQuotes.estimatedProfitnumberrequiredvenueSoloQuotes.returnPctnumberrequiredvenueSoloQuotes.statusstringrequiredvenueSoloQuotes.fillsarray<object>requiredvenueSoloQuotes.allocationsarray<object>venueSoloQuotes.bridgeStepsarray<object>venueSoloQuotes.setupCostsarray<object>venueSoloQuotes.setupCostsTotalnumberallocationsarray<object>allocations.sourceChainIdstringrequiredallocations.venuestringrequiredallocations.amountnumberrequiredallocations.sourceTokenAddressstringallocations.custodyKind"EOA" | "DEPOSIT_WALLET"Allowed values:
"EOA" | "DEPOSIT_WALLET"allocations.custodyAddressstringallocations.exactTokenbooleanbridgeStepsarray<object>bridgeSteps.sourceChainIdstringrequiredbridgeSteps.destChainIdstringrequiredbridgeSteps.amountnumberrequiredbridgeSteps.costnumberrequiredbridgeSteps.sourceTokenAddressstringbridgeSteps.destTokenAddressstringfeeBreakdownobjectfeeBreakdown.rawExecCostnumberrequiredfeeBreakdown.venueFeesnumberrequiredfeeBreakdown.bridgeFeesnumberrequiredfeeBreakdown.executionGasnumberrequiredfeeBreakdown.totalCostnumberrequiredfeeBreakdown.setupCostsarray<object>feeBreakdown.setupCostsTotalnumberfeeBreakdown.appFeenumberfeeBreakdown.appFeeBipsnumberfeeBreakdown.appFeeCategorystringslippageobjectslippage.vwapnumberrequiredslippage.refMidpointnumberrequiredslippage.slippagenumberrequiredslippage.slippageBpsnumberrequiredoptimaobjectoptima.maxFilledQtynumberrequiredoptima.minSlippagenumberrequiredoptima.minCostnumberrequiredoptima.minRisknumberrequiredoptima.minBridgesnumberrequiredoptima.minVenuesnumberrequiredwarningsarray<object>warnings.venuestringrequiredwarnings.venueMarketOutcomeIdstringrequiredwarnings.reasonstringrequiredmessagestringsettlementPlanobjectsettlementPlan.redeemIdstringrequiredsettlementPlan.status"redeem_only" | "partial_redeem"requiredAllowed values:
"redeem_only" | "partial_redeem"settlementPlan.messagestringrequiredsettlementPlan.totalRedeemableSharesnumberrequiredsettlementPlan.totalRedeemSharesnumberrequiredsettlementPlan.totalSellSharesnumberrequiredsettlementPlan.redeemLegsarray<object>requiredestimatedPayoutnumbertotalCostIncFeesnumberestimatedProfitnumberreturnPctnumberpositionAvailabilityobjectpositionAvailability.totalSellableSharesnumberrequiredpositionAvailability.venueMarketOutcomesarray<object>required