Skip to main content
GET
Quote: a signed order ready to fill

Authorizations

Authorization
string
header
required

API key issued by Aile. Authorization: Bearer . Required for quotes. Optional on the other routes: without it they share the anonymous per-address limit, with it the calls are attributed to you and charged to your own budget.

Query Parameters

sellToken
string
required

Symbol of the token you pay. Case-insensitive. Any token the descriptor lists (tokens or bookTokens); the pairs quoted are the market makers' books'.

Pattern: ^[A-Za-z][A-Za-z0-9]{1,11}$
buyToken
string
required

Symbol of the token you receive. Case-insensitive. Any token the descriptor lists (tokens or bookTokens).

Pattern: ^[A-Za-z][A-Za-z0-9]{1,11}$
sellAmount
string

Exact-in: base units you pay. Give exactly one of sellAmount / buyAmount.

Pattern: ^[1-9]\d{0,77}$
buyAmount
string

Exact-out: base units you receive. Give exactly one of sellAmount / buyAmount.

Pattern: ^[1-9]\d{0,77}$
taker
string
required

The address that will send the fill and receive the bought token. The order is pinned to it: a fill sent from another address reverts.

Pattern: ^0x[0-9a-fA-F]{40}$

Response

Default Response

A quote: an order signed by the maker, with the calldata that fills it. Approve fill.allowanceTarget, then send fill.to, fill.data and fill.value from taker before expiresAt.

quoteId
string
required

Stable id for this quote.

sellAmount
string
required

Base units the taker pays, the platform fee included. Exact in, at most the amount asked: with a fee, that amount or one base unit less.

buyAmount
string
required

Base units the taker receives.

expiresAt
integer
required

Unix second when the order expires. About 30 seconds after signing.

maxFirmSize
object
required

The largest quote this maker can pay now, in both tokens at the quoted rate.

extension
string
required

Order extension. 0x without a platform fee; with one, the settlement's fee leg, bound to the order's salt: the taker pays the fee on top of the maker's price.

fees
object
required
alternatives
any[]
required

Other makers' quotes for the same request, best first, each a quote of this shape with its own empty alternatives. Empty for the web app, and while one maker quotes.

maker
object
required
signature
object
required
order
object
required

Aile order. Amounts and traits are decimal strings. Addresses are 0x-prefixed. takingAmount is the maker's net; with a fee the receiver is the settlement, which forwards it to the maker. Informational.

fill
object
required
referenceRate
string
required

Mid rate the quote was priced from, in human units.