Error

A valid request URL is required to generate request examples

{
  "marketAddress": "<string>",
  "marketId": "<string>",
  "request": {
    "quantityBaseUnits": "<string>",
    "spendBaseUnits": "<string>",
    "limitPriceTick": 500,
    "costBoundBaseUnits": "<string>",
    "feeCapBps": 32767,
    "allowPartialFill": true,
    "ownerSelfMatchExcluded": true
  },
  "estimate": {
    "fills": [
      {
        "fillIndex": 4503599627370495,
        "executionPriceTick": 500,
        "makerPriceTick": 500,
        "quantityBaseUnits": "<string>",
        "debitBaseUnits": "<string>",
        "creditBaseUnits": "<string>",
        "feeBaseUnits": "<string>"
      }
    ],
    "filledQuantityBaseUnits": "<string>",
    "unfilledQuantityBaseUnits": "<string>",
    "unspentBaseUnits": "<string>",
    "averageExecutionPriceTick": {
      "numerator": "<string>",
      "denominator": "<string>",
      "floor": "<string>"
    },
    "worstExecutionPriceTick": 500,
    "expectedReceivedQuantityBaseUnits": "<string>",
    "expectedProceedsBaseUnits": "<string>",
    "totalFeeBaseUnits": "<string>",
    "requiredCollateralBaseUnits": "<string>",
    "currentSpendableBaseUnits": "<string>",
    "priceImpactBps": {
      "numerator": "<string>",
      "denominator": "<string>",
      "floor": "<string>"
    }
  },
  "spendable": {
    "status": "available",
    "amountBaseUnits": "<string>",
    "confirmedWalletBalanceBaseUnits": "<string>",
    "activeCollateralHoldsBaseUnits": "<string>",
    "matchedBuyObligationsBaseUnits": "<string>",
    "openSellHoldsBaseUnits": "<string>",
    "matchedSellObligationsBaseUnits": "<string>",
    "pendingDepositsBaseUnits": "<string>",
    "pendingOutflowsBaseUnits": "<string>",
    "custodyOperationActive": true,
    "settlementTokenId": "<string>",
    "evaluatedAt": "2023-11-07T05:31:56Z"
  },
  "bookVersion": "<string>",
  "streamCursor": "<string>",
  "quotedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "warnings": [
    {
      "message": "<string>"
    }
  ],
  "guaranteed": false
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

Trading

Simulate a BUY or SELL against the canonical instant matcher.

Uses the same candidate ordering, fee, rounding, AON/IOC, cost-bound and breaker logic as execution. The quote is point-in-time and is never a guaranteed fill. Exact financial values are decimal strings. Anonymous access remains available; a presented developer key requires market:read. A wallet session adds self-match exclusion and authoritative spendable data; when combined with a developer key, that private enrichment additionally requires account:read.

POST

markets

{address}

quote

Error

A valid request URL is required to generate request examples

{
  "marketAddress": "<string>",
  "marketId": "<string>",
  "request": {
    "quantityBaseUnits": "<string>",
    "spendBaseUnits": "<string>",
    "limitPriceTick": 500,
    "costBoundBaseUnits": "<string>",
    "feeCapBps": 32767,
    "allowPartialFill": true,
    "ownerSelfMatchExcluded": true
  },
  "estimate": {
    "fills": [
      {
        "fillIndex": 4503599627370495,
        "executionPriceTick": 500,
        "makerPriceTick": 500,
        "quantityBaseUnits": "<string>",
        "debitBaseUnits": "<string>",
        "creditBaseUnits": "<string>",
        "feeBaseUnits": "<string>"
      }
    ],
    "filledQuantityBaseUnits": "<string>",
    "unfilledQuantityBaseUnits": "<string>",
    "unspentBaseUnits": "<string>",
    "averageExecutionPriceTick": {
      "numerator": "<string>",
      "denominator": "<string>",
      "floor": "<string>"
    },
    "worstExecutionPriceTick": 500,
    "expectedReceivedQuantityBaseUnits": "<string>",
    "expectedProceedsBaseUnits": "<string>",
    "totalFeeBaseUnits": "<string>",
    "requiredCollateralBaseUnits": "<string>",
    "currentSpendableBaseUnits": "<string>",
    "priceImpactBps": {
      "numerator": "<string>",
      "denominator": "<string>",
      "floor": "<string>"
    }
  },
  "spendable": {
    "status": "available",
    "amountBaseUnits": "<string>",
    "confirmedWalletBalanceBaseUnits": "<string>",
    "activeCollateralHoldsBaseUnits": "<string>",
    "matchedBuyObligationsBaseUnits": "<string>",
    "openSellHoldsBaseUnits": "<string>",
    "matchedSellObligationsBaseUnits": "<string>",
    "pendingDepositsBaseUnits": "<string>",
    "pendingOutflowsBaseUnits": "<string>",
    "custodyOperationActive": true,
    "settlementTokenId": "<string>",
    "evaluatedAt": "2023-11-07T05:31:56Z"
  },
  "bookVersion": "<string>",
  "streamCursor": "<string>",
  "quotedAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "warnings": [
    {
      "message": "<string>"
    }
  ],
  "guaranteed": false
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

x-aura-developer-key

string

header

required

Builder identity and quota key. It never substitutes for a wallet session or restricted trading authorization and can never sign or custody assets.

Path Parameters

address

string

required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

Body

application/json

outcome

enum<string>

required

Available options:

yes,

no

side

enum<string>

required

Available options:

buy,

sell

orderType

enum<string>

required

Available options:

gtc_limit,

ioc_market

quantityBaseUnits

string

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

spendBaseUnits

string

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

limitPriceTick

integer

Price as integer ticks of 0.001 (0=No, 1000=Yes).

Required range: 0 <= x <= 1000

costBoundBaseUnits

string

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

feeCapBps

integer

Required range: 0 <= x <= 65535

allowPartialFill

boolean

default:true

expectedBookVersion

string

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

Response

Default Response

marketAddress

string

required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

marketId

string

required

Pattern: ^[0-9a-f]{64}$

request

object

required

Show child attributes

estimate

object

required

Show child attributes

spendable

object

required

Option 1
Option 2
Option 3
Option 4

Show child attributes

bookVersion

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

streamCursor

string

required

quotedAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

expiresAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

warnings

object[]

required

Show child attributes

guaranteed

enum<boolean>

required

Available options:

false

Last modified on August 11, 2026

Get Started

Guides

Reference

Endpoints

Realtime Stream

Simulate a BUY or SELL against the canonical instant matcher.

Authorizations

Path Parameters

Body

Response