Skip to main content

1. Create an API key

To authenticate your requests you need an API key.
1

Go to your Dashboard

Navigate to your Dashboard and sign in.
2

Open API Keys

Click API Keys in the sidebar.
3

Create a new key

Click Create New API Key and give it a name.
4

Copy your key

Copy the API key immediately — it won’t be shown again.

2. Install the SDK and CLI (preferred)

The Python client and terminal CLI ship in the same entityml package.
The previous split-package naming has changed. Use pip install entityml; you do not need a separate CLI package.

Historical coverage

  • Orderbook data exists for a subset of markets from 2025-09-01 on Polymarket and 2026-02-17 for Kalshi, but coverage is not continuous.
  • Broad Polymarket crypto-related market coverage begins on 2026-02-04. Broad Kalshi crypto-related market coverage begins on 2026-02-25.
  • Broad all-market capture begins on 2026-04-02 for Polymarket and 2026-03-31 for Kalshi, with known April 2026 quality exceptions.
The best way to confirm what exists for a specific market is to call the corresponding date-range endpoint first:
  • GET /api/v1/polymarket/market/date-range
  • GET /api/v1/kalshi/market/date-range
For known parser and collector gap windows, see Data Quality.

Look up condition IDs from a Polymarket slug

If you only have a Polymarket slug, copy it from the event URL: https://polymarket.com/event/<slug> Then use the API lookup endpoint:
See Look Up Polymarket Slug for the full response format.

3. Make your first request with the Python SDK

For full SDK usage, see Python SDK.

4. Make your first request with the CLI

For the full command reference, see CLI.

5. Raw HTTP fallback

6. Raw HTTP code examples

7. Demo

Watch the walkthrough to see the API in action:
The entityml package repository includes the SDK and CLI source, packaging configuration, and examples:

entityml on GitHub

Use the source repository for local development and package release history.