Skip to main content
GET
/
v1
/
markets
/
{address}
Error
A valid request URL is required to generate request examples
{
  "id": 0,
  "marketAddress": "<string>",
  "question": "<string>",
  "category": "<string>",
  "tags": [
    "<string>"
  ],
  "creator": "<string>",
  "resolved": true,
  "finalOutcome": 0,
  "volume": "<string>",
  "bestBidYes": 500,
  "bestAskYes": 500,
  "bestBidNo": 500,
  "bestAskNo": 500,
  "createdAt": "<string>",
  "metadata": {},
  "imageUrl": "<string>",
  "rules": "<string>",
  "resolutionSources": "<string>",
  "master": true,
  "masterQuestion": "<string>",
  "masterImage": "<string>",
  "linked": true,
  "proposalId": 0
}

Authorizations

​
Authorization
string
header
required

API key obtained from POST /v1/auth/keys.

Path Parameters

​
address
string
required

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

Required string length: 30 - 80
Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

Response

Default Response

​
id
integer
required

Database id (stable, monotonic).

Required range: -9007199254740991 <= x <= 9007199254740991
​
marketAddress
string
required

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

Required string length: 30 - 80
Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$
​
question
string
required
​
category
string | null
required
​
tags
string[]
required

Cross-cutting labels (e.g. ["nfl","superbowl"]). Empty if absent.

​
creator
string | null
required

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

Required string length: 30 - 80
Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$
​
resolved
boolean
required
​
finalOutcome
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
​
volume
string
required

Total traded volume in collateral base units (string, preserves precision).

​
bestBidYes
integer | null
required

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

Required range: 0 <= x <= 1000
​
bestAskYes
integer | null
required

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

Required range: 0 <= x <= 1000
​
bestBidNo
integer | null
required

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

Required range: 0 <= x <= 1000
​
bestAskNo
integer | null
required

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

Required range: 0 <= x <= 1000
​
createdAt
string
required

ISO-8601.

​
metadata
object
required
​
imageUrl
string | null
​
rules
string | null
​
resolutionSources
string | null
​
master
boolean
​
masterQuestion
string | null
​
masterImage
string | null
​
linked
boolean
​
proposalId
integer | null
Required range: -9007199254740991 <= x <= 9007199254740991