Skip to main content
GET
/
v1
/
search
/
Error
A valid request URL is required to generate request examples
{
  "results": [
    {
      "type": "market",
      "score": 123,
      "data": {
        "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
      }
    }
  ],
  "facets": {
    "types": {}
  },
  "fuzzyFallbackUsed": true
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
q
string
required

Query string (websearch syntax: AND, OR, NOT, "phrases").

Required string length: 1 - 200
​
types
string

Comma-separated list of resource types to include. Allowed: market. Defaults to all.

​
limit
integer
default:20
Required range: 1 <= x <= 50
​
fuzzy
boolean
default:true

Response

Default Response

​
results
object[]
required
​
facets
object
required
​
fuzzyFallbackUsed
boolean
required

True when the strict tsquery returned 0 hits and we fell back to trigram fuzzy matching.