Documentation

Get started

PokerWorks Developer Platform is in closed beta. If your account has access, you can create a test key in the Console and make your first calculation call with cURL in about five minutes.

Which key do I use?

pw_test_…Calculation API — Test calculation calls.

pw_live_…Calculation API — Live calculation calls.

pw_mgmt_…Automation & management — Service-account automation and management HTTP contracts. Never calculation calls.

1. Create an account

Sign up in the console with Google or email magic link. Closed-beta access may require your account to be enabled before live traffic or gated features are available. Test keys and free credits are the starting path for invited developers.

2. Create a test key

In the console, open API keys and create a test key (pw_test_…). The raw key is shown once at creation — copy it then. We store only its hash; it can't be recovered, only rotated or revoked.

Send it as a bearer token: Authorization: Bearer pw_test_…

3. Make your first call

Start with the smallest possible request: the equity of one hand against another. Paths are versioned under /v1/….

cURL
curl https://api.pokerworks.io/v1/calculations/equity/holdem \
  -H "Authorization: Bearer pw_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "players": [
      { "id": "hero",    "mode": "hand", "hand": ["As", "Ah"] },
      { "id": "villain", "mode": "hand", "hand": ["Kd", "Kc"] }
    ]
  }'

That's a complete, metered call against your test environment. Once it works, add ranges, a board, dead cards, or more players — see Hold'em equity.

4. Read the response

Every response comes back in the same envelope, so you can handle them uniformly:

requestId — quote it in support requests.
creditsCharged — what this call cost.
engine — the calculation engine that produced the result.
method — how the result was computed, e.g. exact, monte-carlo, or deterministic.
warnings — non-fatal warnings returned as strings.
result — the calculation itself (here, each player's equity).

Hold'em equity uses engine: "poker-lab-tools/odds-calculator". Exact hand scenarios usually return method.type: "exact"; range-heavy scenarios can return method.type: "monte-carlo" with sampleCount and optional marginOfErrorPct.

5. Go live

Closed-beta live traffic is enabled account by account. Stripe-backed billing is the planned payment rail, but paid-flow proof is still part of launch readiness; until your account is enabled for paid usage, treat beta access as free or manually provisioned. Successful calls draw down credits; validation and auth failures are never charged. See Access & limits for the current closed-beta posture.

Automating instead of integrating? Service-account management tokens (pw_mgmt_…) are available for closed-beta accounts. Public CLI, MCP, and management SDK packages are coming soon; until then, use the Console and documented HTTP contracts rather than private monorepo tooling.

Using TypeScript? The public SDK will be published later as @pokerworks/sdk. Beta docs stay cURL/OpenAPI-first until that package is installable outside the monorepo.

Build against the public contract

Model your integration against the public OpenAPI projection — see the API Reference — not internal routes. The public API origin is https://api.pokerworks.io.

How the API works

3. Make your first call

Start with the smallest possible request: the equity of one hand against another. Paths are versioned under /v1/….

cURL

curl https://api.pokerworks.io/v1/calculations/equity/holdem \
  -H "Authorization: Bearer pw_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "players": [
      { "id": "hero",    "mode": "hand", "hand": ["As", "Ah"] },
      { "id": "villain", "mode": "hand", "hand": ["Kd", "Kc"] }
    ]
  }'

That's a complete, metered call against your test environment. Once it works, add ranges, a board, dead cards, or more players — see Hold'em equity.

4. Read the response

Every response comes back in the same envelope, so you can handle them uniformly:

requestId — quote it in support requests.

creditsCharged — what this call cost.

engine — the calculation engine that produced the result.

method — how the result was computed, e.g. exact, monte-carlo, or deterministic.

warnings — non-fatal warnings returned as strings.

result — the calculation itself (here, each player's equity).

5. Go live

Using TypeScript? The public SDK will be published later as @pokerworks/sdk. Beta docs stay cURL/OpenAPI-first until that package is installable outside the monorepo.