Outcome Service Get Outcome Book | Predict API Documentation

{
  "outcome_id": "string",
  "state": "active",
  "as_of": "2024-01-15T09:30:00Z",
  "revision": "string",
  "depth": 1,
  "sides": [
    {
      "side": 1,
      "bids": [
        {
          "price": "string",
          "size": "string",
          "orders": [
            {
              "oid": "string",
              "address": "string",
              "size": "string",
              "priority": 1,
              "source_side": 1
            }
          ]
        }
      ],
      "asks": [
        {
          "price": "string",
          "size": "string",
          "orders": [
            {
              "oid": "string",
              "address": "string",
              "size": "string",
              "priority": 1,
              "source_side": 1
            }
          ]
        }
      ]
    }
  ],
  "accounts": {
    "data": [
      {
        "address": "string",
        "username": "string",
        "image_url": "string",
        "hyperliquid_name": "string",
        "account_type": "main"
      }
    ]
  }
}

Path parameters

idstringRequired

Stable unique identifier for the id.

Query parameters

depthintegerOptional

Number of price levels per side. Defaults to 10 when omitted. 0 is the full book.

includelist of stringsOptional

Optional sidecars. Repeatable and comma-separated; empty means none. The first supported token is accounts.

Response

outcome_idstringOptional

Stable unique identifier for the outcome.

stateenumOptional

Allowed value for state.

Allowed values:

as_ofdatetimeOptional

revisionstringOptional

depthintegerOptional

sideslist of objectsOptional

Always ordered by side: first 0, then 1.

accountsobjectOptional

Errors

400

Bad Request Error

404

Not Found Error

405

Method Not Allowed Error

500

Internal Server Error

503

Service Unavailable Error