### Example Request Body

Source: https://falcon-bot.gitbook.io/falcon-api/getting-started/quickstart

An example JSON payload for a POST request to retrieve data.

```json
{
  "agent_id": 555,
  "params": {
    "closed": "False"
  },
  "pagination": {
    "limit": 10,
    "offset": 0
  },
  "formatter_config": {
    "format_type": "raw"
  }
}
```

--------------------------------

### Querying Documentation

Source: https://falcon-bot.gitbook.io/falcon-api/getting-started/quickstart

Example of how to query the documentation dynamically using the 'ask' query parameter.

```text
GET https://falcon-bot.gitbook.io/falcon-api/getting-started/quickstart.md?ask=<question>
```

--------------------------------

### cURL Example Request

Source: https://falcon-bot.gitbook.io/falcon-api/getting-started/quickstart

Example of making a POST request to the Falcon API using cURL.

```bash
curl -X POST https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ \
    "agent_id": 555, \
    "params": {"closed": "False"}, \
    "pagination": {"limit": 10, "offset": 0}, \
    "formatter_config": {"format_type": "raw"} \
  }'
```

--------------------------------

### Python Example Request

Source: https://falcon-bot.gitbook.io/falcon-api/getting-started/quickstart

Example of making a POST request to the Falcon API using Python's requests library.

```python
import requests

url = "https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized"

headers = {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
}

payload = {
    "agent_id": 555,
    "params": {"closed": "False"},
    "pagination": {"limit": 10, "offset": 0},
    "formatter_config": {"format_type": "raw"}
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

--------------------------------

### JavaScript Example Request

Source: https://falcon-bot.gitbook.io/falcon-api/getting-started/quickstart

Example of making a POST request to the Falcon API using JavaScript's fetch API.

```javascript
const response = await fetch(
  "https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized",
  {
    method: "POST",
    headers: {
      "Authorization": "Bearer YOUR_TOKEN",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      agent_id: 555,
      params: { closed: "False" },
      pagination: { limit: 10, offset: 0 },
      formatter_config: { format_type: "raw" }
    })
  }
);

const data = await response.json();
console.log(data);
```

--------------------------------

### Query Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/reference

This example shows how to ask a question to the documentation dynamically by performing an HTTP GET request with the `ask` query parameter.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/reference.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/traders

An example of how to perform an HTTP GET request to query the documentation dynamically using the 'ask' query parameter.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/traders.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://falcon-bot.gitbook.io/falcon-api/reference/core-concepts

Example of how to perform an HTTP GET request to query the documentation dynamically.

```http
GET https://falcon-bot.gitbook.io/falcon-api/reference/core-concepts.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/trade-data/trades/kalshi-trades

Example of how to perform an HTTP GET request to query the documentation dynamically using the `ask` query parameter.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/trade-data/trades/kalshi-trades.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/getting-started

To get additional information not directly available on the page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

```http
GET https://falcon-bot.gitbook.io/falcon-api/getting-started.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/trade-data

This example shows how to perform an HTTP GET request to query the documentation dynamically using the `ask` query parameter.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/trade-data.md?ask=<question>
```

--------------------------------

### Dynamic Querying Example

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/markets/kalshi-markets

Demonstrates how to query the documentation dynamically by appending an 'ask' parameter to the GET request URL.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/market-data/markets/kalshi-markets.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/trade-data/trades

Example of how to perform an HTTP GET request to query the documentation dynamically with the 'ask' query parameter.

```http
GET https://falcon-bot.gitbook.io/falcon-api/trade-data/trades.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/traders/lifetime-performance

Example of how to perform an HTTP GET request to query the documentation dynamically with an 'ask' query parameter.

```http
GET https://falcon-bot.gitbook.io/falcon-api/traders/lifetime-performance.md?ask=<question>
```

--------------------------------

### Dynamic Documentation Query Example

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/markets/polymarket-markets

Demonstrates how to perform an HTTP GET request to the current page URL with an 'ask' query parameter to dynamically query the documentation for specific information.

```http
GET https://falcon-bot.gitbook.io/falcon-api/market-data/markets/polymarket-markets.md?ask=<question>
```

--------------------------------

### Authentication Example

Source: https://falcon-bot.gitbook.io/falcon-api

Example of how to include the Bearer token in the Authorization header.

```http
Authorization: Bearer YOUR_API_TOKEN
```

--------------------------------

### Example Request (cURL)

Source: https://falcon-bot.gitbook.io/falcon-api/trade-data/trades/polymarket-trades

An example cURL command to retrieve Polymarket trade data.

```bash
curl --location 'https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{
    "agent_id": 556,
    "params": {
        "proxy_wallet": "ALL",
        "condition_id": "ALL",
        "market_slug": "bitcoin-up-or-down-january-9-10am-et",
        "side": "BUY",
        "start_time": "1767973812",
        "end_time": "1767973860"
    },
    "pagination": {
        "limit": 10,
        "offset": 0
    },
    "formatter_config": {
        "format_type": "raw"
    }
}'
```

--------------------------------

### Example Response

Source: https://falcon-bot.gitbook.io/falcon-api/traders/top-traders

This is an example of the JSON response you can expect when querying for top traders.

```bash
{ 
  "timestamp": "",
  "params": {
    "leaderboard_period": "1d",
    "max_sharpe_ratio": "-1.0",
    "max_total_pnl": "-1.0",
    "max_win_rate": "-1.0",
    "min_sharpe_ratio": "-1.0",
    "min_total_pnl": "-1.0",
    "min_win_rate": "-1.0",
    "wallet_address": "ALL"
  },
  "pagination": {
    "limit": 50,
    "offset": 0,
    "has_more": true
  },
  "data": {
    "results": [
      {
        "address": "0x0720803c7cb0d0c5a928787b3b7ea148c6831cdb",
        "markets_traded": 1,
        "rank": 1,
        "roi": "0.414952",
        "sharpe_ratio": null,
        "total_pnl": "1494121.7168",
        "total_trades": 69,
        "total_volume": "3600711.99",
        "win_rate": "1.0000"
      },
      {
        "address": "0xe90bec87d9ef430f27f9dcfe72c34b76967d5da2",
        "markets_traded": 50,
        "rank": 2,
        "roi": "0.355880",
        "sharpe_ratio": "0.2847",
        "total_pnl": "1092294.3287",
        "total_trades": 1829,
        "total_volume": "3069274.68",
        "win_rate": "0.6290"
      },
      {
        "address": "0xdc876e6873772d38716fda7f2452a78d426d7ab6",
        "markets_traded": 78,
        "rank": 3,
        "roi": "0.793496",
        "sharpe_ratio": "0.1526",
        "total_pnl": "425301.6430",
        "total_trades": 1662,
        "total_volume": "535984.74",
        "win_rate": "0.5275"
      },
      {
        "address": "0x07b8e44b90cc3e91b8d5fe60ea810d2534638e25",
        "markets_traded": 12,
        "rank": 4,
        "roi": "0.806624",
        "sharpe_ratio": "0.2070",
        "total_pnl": "418635.9796",
        "total_trades": 386,
        "total_volume": "518997.59",
        "win_rate": "0.6875"
      },
      {
        "address": "0xe20a1538293903b746ffe6c4ce2d5c3c0300e469",
        "markets_traded": 11,
        "rank": 5,
        "roi": "0.810739",
        "sharpe_ratio": "0.4343",
        "total_pnl": "390127.1799",
        "total_trades": 132,
        "total_volume": "481199.58",
        "win_rate": "0.5294"
      },
      {
        "address": "0xead152b855effa6b5b5837f53b24c0756830c76a",
        "markets_traded": 252,
        "rank": 6,
        "roi": "0.212866",
        "sharpe_ratio": "0.0548",
        "total_pnl": "297035.2810",
        "total_trades": 11394,
        "total_volume": "1395408.27",
        "win_rate": "0.5000"
      },
      {
        "address": "0x8e433d051bfb5cc6a1f7e5a0452029b7ffb4a3cd",
        "markets_traded": 27,
        "rank": 7,
        "roi": "0.172945",
        "sharpe_ratio": "0.0856",
        "total_pnl": "235485.7051",
        "total_trades": 1905,
        "total_volume": "1361619.99",
        "win_rate": "0.6667"
      },
      {
        "address": "0xc29e1cef4256f423e5a3e713d886bd25f98da2ca",
        "markets_traded": 7,
        "rank": 8,
        "roi": "9.010307",
        "sharpe_ratio": "0.3114",
        "total_pnl": "216247.3168",
        "total_trades": 42,
        "total_volume": "23999.99",
        "win_rate": "0.5000"
      },
      {
        "address": "0x507e52ef684ca2dd91f90a9d26d149dd3288beae",
        "markets_traded": 661,
        "rank": 9,
        "roi": "0.148986",
        "sharpe_ratio": "0.0488",
        "total_pnl": "215344.9641",
        "total_trades": 10517,
        "total_volume": "1445402.83",
        "win_rate": "0.6104"
      },
      {
        "address": "0x02227b8f5a9636e895607edd3185ed6ee5598ff7",
        "markets_traded": 2,
        "rank": 10,
        "roi": "0.920197",
        "sharpe_ratio": "0.8352",
        "total_pnl": "204722.6511",
        "total_trades": 115,
        "total_volume": "222476.93",
        "win_rate": "1.0000"
      },
      {
        "address": "0xc6b6ffce6c52b6fdf4bad57de303939f19ab13ac",
        "markets_traded": 3,
        "rank": 11,
        "roi": "0.898256",
        "sharpe_ratio": "0.3935",
        "total_pnl": "175596.6445",
        "total_trades": 7,
        "total_volume": "195486.27",
        "win_rate": "0.3333"
      }
    ]
  }
}

```

--------------------------------

### Example Request (curl)

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/orderbook

An example of how to make a request to the orderbook API using curl.

```bash
curl --location 'https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{ \
    "agent_id": 572, \
    "params": { \
        "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235", \
        "start_time": "1769902905868", \
        "end_time": "1770034843377" \
    }, \
    "formatter_config": { \
        "format_type": "raw" \
    } \
}'
```

--------------------------------

### Example Request (cURL)

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/markets/kalshi-markets

This is a cURL command example for requesting Kalshi market data.

```bash
curl --location 'https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{ \
    "agent_id": 565, \
    "params": { \
        "ticker": "KXSOL15M-26MAR180800-00", \
        "event_ticker": "KXSOL15M-26MAR180800", \
        "title": "SOL price", \
        "status": "finalized", \
        "close_time_min": "1773589812", \
        "close_time_max": "1774021812" \
    }, \
    "pagination": { \
        "limit": 10, \
        "offset": 0 \
    }, \
    "formatter_config": { \
        "format_type": "raw" \
    } \
}'
```

--------------------------------

### Example Request (cURL)

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/markets/polymarket-markets

Example cURL command to request Polymarket market data.

```bash
curl --location 'https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{ \
    "agent_id": 574, \
    "params": { \
        "min_volume": "100", \
        "condition_id": "0xeaff81adbcd9dcd88a73a41402cb4a6b87234213a6b3ecaa0441126cde6d5b7f", \
        "market_slug": "bitcoin-up-or-down-january-17-3pm-et", \
        "event_slug": "bitcoin-up-or-down-january-17-3pm-et", \
        "end_date_min": "1768467703", \
        "end_date_max": "1769213303", \
        "closed": "True" \
    }, \
    "pagination": { \
        "limit": 100, \
        "offset": 0 \
    }, \
    "formatter_config": { \
        "format_type": "raw" \
    } \
}'
```

--------------------------------

### Request Body Example

Source: https://falcon-bot.gitbook.io/falcon-api/traders/profit-and-loss

An example of the JSON request body used to query profit and loss data.

```json
{
    "agent_id": 569,
    "params": {
        "granularity": "1d",
        "wallet": "0x8e433d051bfb5cc6a1f7e5a0452029b7ffb4a3cd",
        "start_time": "2026-02-10",
        "end_time": "2026-02-28"
    },
    "formatter_config": {
        "format_type": "raw"
    }
}
```

--------------------------------

### Example Request (cURL)

Source: https://falcon-bot.gitbook.io/falcon-api/market-intelligence/market-insights

Example cURL command to retrieve market insights with a specific request body.

```bash
curl --location 'https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{ \
    "agent_id": 575, \
    "params": { \
        "condition_id": "ALL", \
        "min_volume_24h" : "0", \
        "min_liquidity_percentile" : "0", \
        "volume_trend" : "ALL", \
        "min_top1_wallet_pct" : "0", \
        "max_unique_traders_7d" : "0" \
    }, \
    "formatter_config": { \
        "format_type": "raw" \
    } \
}'
```

--------------------------------

### Example Request (cURL)

Source: https://falcon-bot.gitbook.io/falcon-api/traders/lifetime-performance

An example cURL command to make a request for lifetime performance data.

```bash
curl --location 'https://narrative.agent.heisenberg.so/api/v2/semantic/retrieve/parameterized' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data '{ \
    "agent_id": 586, \
    "params": { \
        "wallet_address": "0x6ac5bb06a9eb05641fd5e82640268b92f3ab4b6e" \
    }, \
    "pagination": { \
        "limit": 50, \
        "offset": 0 \
    }, \
    "formatter_config": { \
        "format_type": "raw" \
    } \
}'
```

--------------------------------

### Base URL

Source: https://falcon-bot.gitbook.io/falcon-api/getting-started/quickstart

The base URL for all Falcon API requests.

```text
https://narrative.agent.heisenberg.so/api
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/market-intelligence

This example shows how to query the documentation dynamically by appending an 'ask' parameter to the URL with a natural language question.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/market-intelligence.md?ask=<question>
```

--------------------------------

### Querying This Documentation

Source: https://falcon-bot.gitbook.io/falcon-api/traders/profit-and-loss

Instructions on how to dynamically query the documentation using an HTTP GET request with an 'ask' query parameter.

```http
GET https://falcon-bot.gitbook.io/falcon-api/traders/profit-and-loss.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/reference/best-practices

To get additional information not directly available on a page, you can query the documentation dynamically by asking a question. This involves performing an HTTP GET request on the page URL with the `ask` query parameter.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/reference/best-practices.md?ask=<question>
```

--------------------------------

### Query Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/market-data

This example shows how to query the documentation dynamically by appending an 'ask' parameter to the URL with a natural language question.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/market-data.md?ask=<question>
```

--------------------------------

### Example Response

Source: https://falcon-bot.gitbook.io/falcon-api/reference/api-structure

A complete example of a Falcon API response.

```json
{
  "timestamp": "2025-01-09T19:12:50Z",
  "params": {},
  "pagination": {
    "limit": 10,
    "offset": 0,
    "has_more": true
  },
  "data": {
    "results": []
  }
}
```

--------------------------------

### Example Response

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/orderbook

An example of the JSON response from the Order Book API.

```json
{
  "timestamp": "",
  "params": {
    "end_time": "1770034843377",
    "start_time": "1769902905868",
    "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235"
  },
  "pagination": {
    "limit": 200,
    "offset": 0,
    "has_more": false
  },
  "data": {
    "results": [
      {
        "asks": "[{"size": "60", "price": "0.99"}, {"size": "723.17", "price": "0.93"}, {"size": "12", "price": "0.91"}]",
        "bids": "[{"size": "60", "price": "0.01"}, {"size": "25", "price": "0.02"}, {"size": "5.63", "price": "0.03"}, {"size": "12", "price": "0.09"}, {"size": "12", "price": "0.19"}, {"size": "200", "price": "0.28"}, {"size": "29.48", "price": "0.29"}]",
        "timestamp": "2026-02-02T12:01:20.885Z",
        "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235"
      },
      {
        "asks": "[{"size": "60", "price": "0.99"}, {"size": "5", "price": "0.98"}, {"size": "723.17", "price": "0.93"}, {"size": "12", "price": "0.91"}]",
        "bids": "[{"size": "60", "price": "0.01"}, {"size": "30", "price": "0.02"}, {"size": "5.63", "price": "0.03"}, {"size": "12", "price": "0.09"}, {"size": "12", "price": "0.19"}, {"size": "200", "price": "0.28"}, {"size": "29.48", "price": "0.29"}]",
        "timestamp": "2026-02-02T10:29:08.324Z",
        "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235"
      },
      {
        "asks": "[{"size": "60", "price": "0.99"}, {"size": "5", "price": "0.98"}, {"size": "714.29", "price": "0.93"}, {"size": "23.1", "price": "0.91"}]",
        "bids": "[{"size": "60", "price": "0.01"}, {"size": "30", "price": "0.02"}, {"size": "5.63", "price": "0.03"}, {"size": "12", "price": "0.09"}, {"size": "12", "price": "0.19"}, {"size": "200", "price": "0.28"}, {"size": "29.48", "price": "0.29"}]",
        "timestamp": "2026-02-02T09:53:57.168Z",
        "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235"
      },
      {
        "asks": "[{"size": "60", "price": "0.99"}, {"size": "5", "price": "0.98"}, {"size": "714.29", "price": "0.93"}, {"size": "357", "price": "0.92"}, {"size": "23.1", "price": "0.91"}]",
        "bids": "[{"size": "60", "price": "0.01"}, {"size": "30", "price": "0.02"}, {"size": "20.63", "price": "0.03"}, {"size": "12", "price": "0.09"}, {"size": "12", "price": "0.19"}, {"size": "200", "price": "0.28"}, {"size": "29.48", "price": "0.29"}]",
        "timestamp": "2026-02-02T09:46:37.004Z",
        "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235"
      },
      {
        "asks": "[{"size": "60", "price": "0.99"}, {"size": "5", "price": "0.98"}, {"size": "714.29", "price": "0.93"}, {"size": "357", "price": "0.92"}, {"size": "23.1", "price": "0.91"}]",
        "bids": "[{"size": "60", "price": "0.01"}, {"size": "30", "price": "0.02"}, {"size": "20.63", "price": "0.03"}, {"size": "12", "price": "0.09"}, {"size": "12", "price": "0.19"}, {"size": "200", "price": "0.28"}, {"size": "29.48", "price": "0.29"}]",
        "timestamp": "2026-02-02T09:37:53.29Z",
        "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235"
      },
      {
        "asks": "[{"size": "60", "price": "0.99"}, {"size": "5", "price": "0.98"}, {"size": "714.29", "price": "0.93"}, {"size": "357", "price": "0.92"}, {"size": "23.1", "price": "0.91"}]",
        "bids": "[{"size": "60", "price": "0.01"}, {"size": "30", "price": "0.02"}, {"size": "20.63", "price": "0.03"}, {"size": "12", "price": "0.09"}, {"size": "12", "price": "0.19"}, {"size": "200", "price": "0.28"}, {"size": "29.48", "price": "0.29"}]",
        "timestamp": "2026-02-02T09:20:49.337Z",
        "token_id": "69435545313357346912686520645149775930858973121193492847015767460308803044235"
      }
    ]
  }
}
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/market-intelligence/falcon-wallet-360

Demonstrates how to perform an HTTP GET request to query the documentation with an 'ask' parameter for specific questions.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/market-intelligence/falcon-wallet-360.md?ask=<question>
```

--------------------------------

### Querying Documentation Dynamically

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/markets

To get additional information not directly available on a page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter. The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/market-data/markets.md?ask=<question>
```

--------------------------------

### Example Response

Source: https://falcon-bot.gitbook.io/falcon-api/trade-data/trades/kalshi-trades

An example of the JSON response when fetching Kalshi trade data.

```json
{
  "timestamp": "",
  "params": {
    "condition_id": "ALL",
    "end_time": "1767973860",
    "market_slug": "bitcoin-up-or-down-january-9-10am-et",
    "proxy_wallet": "ALL",
    "side": "BUY",
    "start_time": "1767973812",
    "wallet_proxy": "ALL"
  },
  "pagination": {
    "limit": 10,
    "offset": 0,
    "has_more": true
  },
  "data": {
    "results": [
      {
        "condition_id": "0x584654c869a3f1868f3ad1248e11ea988f3c4e332002839c6cac0e6db94485ee",
        "id": "0x19320a9cfc47d70e2ac56c25b3555a34f402484a236267a8c220fa060eba74c7_0x1e30835026c910cd5f676a504ce8c39666917f402dfe93bb46c19adf6b152c13",
        "outcome": "Down",
        "price": 0.001,
        "proxy_wallet": "0x11514fb5ef1e3fe110691243714fcf2182db1fed",
        "side": "BUY",
        "size": 225.23,
        "slug": "bitcoin-up-or-down-january-9-10am-et",
        "timestamp": "2026-01-09T15:51:00Z",
        "transaction_hash": "0x19320a9cfc47d70e2ac56c25b3555a34f402484a236267a8c220fa060eba74c7"
      },
      {
        "condition_id": "0x584654c869a3f1868f3ad1248e11ea988f3c4e332002839c6cac0e6db94485ee",
        "id": "0x19320a9cfc47d70e2ac56c25b3555a34f402484a236267a8c220fa060eba74c7_0xb07225fa95a2b5dd0f15b3f41f07657d9eb9e928268d4e5ae9fdf7e178049ac7",
        "outcome": "Down",
        "price": 0.001,
        "proxy_wallet": "0x11514fb5ef1e3fe110691243714fcf2182db1fed",
        "side": "BUY",
        "size": 14.99,
        "slug": "bitcoin-up-or-down-january-9-10am-et",
        "timestamp": "2026-01-09T15:51:00Z",
        "transaction_hash": "0x19320a9cfc47d70e2ac56c25b3555a34f402484a236267a8c220fa060eba74c7"
      },
      {
        "condition_id": "0x584654c869a3f1868f3ad1248e11ea988f3c4e332002839c6cac0e6db94485ee",
        "id": "0x828175e5fe3c6688e81bbcd09ac9fb9e4a7b2c135b33cc5311e768d673e09804_0xf47df1130870ac2c859a9719c01e79ecb0f41c1bab1de1d2fc085c7731ebc718",
        "outcome": "Up",
        "price": 0.993,
        "proxy_wallet": "0x4bfb41d5b3570defd03c39a9a4d8de6bd8b8982e",
        "side": "BUY",
        "size": 69,
        "slug": "bitcoin-up-or-down-january-9-10am-et",
        "timestamp": "2026-01-09T15:50:40Z",
        "transaction_hash": "0x828175e5fe3c6688e81bbcd09ac9fb9e4a7b2c135b33cc5311e768d673e09804"
      },
      {
        "condition_id": "0x584654c869a3f1868f3ad1248e11ea988f3c4e332002839c6cac0e6db94485ee",
        "id": "0xcd72b1e52c1c74d30f182a2cf5cfed2c6e9d324ffd093b4e1da669efe21b767e_0x99b851adb0c517abd4b5817b291daacfe2219856f491b724daa7f86637a32753",
        "outcome": "Up",
        "price": 0.99299999872234,
        "proxy_wallet": "0x4bfb41d5b3570defd03c39a9a4d8de6bd8b8982e",
        "side": "BUY",
        "size": 302.114802,
        "slug": "bitcoin-up-or-down-january-9-10am-et",
        "timestamp": "2026-01-09T15:50:34Z",
        "transaction_hash": "0xcd72b1e52c1c74d30f182a2cf5cfed2c6e9d324ffd093b4e1da669efe21b767e"
      },
      {
        "condition_id": "0x584654c869a3f1868f3ad1248e11ea988f3c4e332002839c6cac0e6db94485ee",
        "id": "0x5a9fa64c0013b0aa553e15fcf730ba2e8a99b5d11cb880d18dbce8a8896ca9c3_0xae59422ee3f3209fa45dc6a9b7867e7e5a6754ceba4c383f1c210f157cbc5e3e",
        "outcome": "Up",
        "price": 0.9920000000000001,
        "proxy_wallet": "0x4bfb41d5b3570defd03c39a9a4d8de6bd8b8982e",
        "side": "BUY",
        "size": 0.62,
        "slug": "bitcoin-up-or-down-january-9-10am-et",
        "timestamp": "2026-01-09T15:50:20Z",
        "transaction_hash": "0x5a9fa64c0013b0aa553e15fcf730ba2e8a99b5d11cb880d18dbce8a8896ca9c3"
      },
      {
        "condition_id": "0x584654c869a3f1868f3ad1248e11ea988f3c4e332002839c6cac0e6db94485ee",
        "id": "0x5a9fa64c0013b0aa553e15fcf730ba2e8a99b5d11cb880d18dbce8a8896ca9c3_0xc32bb50de6ced5930857d78ce9d0fd8d11d848f898a6cbd246e9d50303dbfd13",
        "outcome": "Down",
        "price": 0.001,
        "proxy_wallet": "0x11514fb5ef1e3fe110691243714fcf2182db1fed",
        "side": "BUY",
        "size": 100,
        "slug": "bitcoin-up-or-down-january-9-10am-et",
        "timestamp": "2026-01-09T15:50:18Z",
        "transaction_hash": "0x5a9fa64c0013b0aa553e15fcf730ba2e8a99b5d11cb880d18dbce8a8896ca9c3"
      }
    ]
  }
}
```

--------------------------------

### params Example

Source: https://falcon-bot.gitbook.io/falcon-api/reference/api-structure

An example of the params field, used for dataset-specific filters.

```json
"params": {
  "closed": "false",
  "market_slug": "bitcoin"
}
```

--------------------------------

### Dynamic Documentation Query

Source: https://falcon-bot.gitbook.io/falcon-api/trade-data/trades/polymarket-trades

Example of how to query the documentation dynamically by appending an 'ask' parameter to the URL with a natural language question.

```HTTP
GET https://falcon-bot.gitbook.io/falcon-api/trade-data/trades/polymarket-trades.md?ask=<question>
```

--------------------------------

### Example Candlestick Response

Source: https://falcon-bot.gitbook.io/falcon-api/market-data/candlesticks

This is an example of the JSON response when requesting candlestick data.

```json
{
  "timestamp": "",
  "params": {
    "end_time": "1770083100",
    "interval": "4h",
    "start_time": "1769910300",
    "token_id": "78633590736077251574794513664747155551297291244492840448622550955320930591622"
  },
  "pagination": {
    "limit": 200,
    "offset": 0,
    "has_more": false
  },
  "data": {
    "results": [
      {
        "ask_close": null,
        "ask_high": "0.9900",
        "ask_low": "0.5100",
        "ask_open": null,
        "bid_close": null,
        "bid_high": "0.5000",
        "bid_low": "0.0100",
        "bid_open": null,
        "candle_time": "2026-02-01T00:00:00Z",
        "close": "0.5100",
        "condition_id": "0x18b1c135d0a40c5894da9412e77311827d9caf16cf4cd6591b247a34730af919",
        "high": "0.5100",
        "low": "0.5000",
        "mean": "0.5033",
        "open": "0.5000",
        "outcome": "No",
        "token_id": "78633590736077251574794513664747155551297291244492840448622550955320930591622",
        "trade_count": 6,
        "volume": "135.97"
      },
      {
        "ask_close": null,
        "ask_high": "0.9900",
        "ask_low": "0.5100",
        "ask_open": "0.9900",
        "bid_close": null,
        "bid_high": "0.5000",
        "bid_low": "0.0100",
        "bid_open": "0.0100",
        "candle_time": "2026-02-01T04:00:00Z",
        "close": "0.5100",
        "condition_id": "0x18b1c135d0a40c5894da9412e77311827d9caf16cf4cd6591b247a34730af919",
        "high": "0.5100",
        "low": "0.5000",
        "mean": "0.5038",
        "open": "0.5000",
        "outcome": "No",
        "token_id": "78633590736077251574794513664747155551297291244492840448622550955320930591622",
        "trade_count": 15,
        "volume": "1020.08"
      },
      {
        "ask_close": null,
        "ask_high": "0.9900",
        "ask_low": "0.5100",
        "ask_open": null,
        "bid_close": null,
        "bid_high": "0.5000",
        "bid_low": "0.0100",
        "bid_open": null,
        "candle_time": "2026-02-01T08:00:00Z",
        "close": "0.5100",
        "condition_id": "0x18b1c135d0a40c5894da9412e77311827d9caf16cf4cd6591b247a34730af919",
        "high": "0.5100",
        "low": "0.5000",
        "mean": "0.5095",
        "open": "0.5100",
        "outcome": "No",
        "token_id": "78633590736077251574794513664747155551297291244492840448622550955320930591622",
        "trade_count": 62,
        "volume": "1137.14"
      },
      {
        "ask_close": null,
        "ask_high": "0.9900",
        "ask_low": "0.5100",
        "ask_open": null,
        "bid_close": null,
        "bid_high": "0.5000",
        "bid_low": "0.0100",
        "bid_open": null,
        "candle_time": "2026-02-01T12:00:00Z",
        "close": "0.5100",
        "condition_id": "0x18b1c135d0a40c5894da9412e77311827d9caf16cf4cd6591b247a34730af919",
        "high": "0.5100",
        "low": "0.5000",
        "mean": "0.5046",
        "open": "0.5100",
        "outcome": "No",
        "token_id": "78633590736077251574794513664747155551297291244492840448622550955320930591622",
        "trade_count": 137,
        "volume": "2748.29"
      }
    ]
  }
}
```