SiriusPortal

SiriusPot Developer Portal

Build with the SiriusPot Jackpot Engine

Comprehensive API reference, interactive explorer, and real-time integration guides for progressive jackpot pools, contribution processing, winner selection, and payment orchestration.

Integration in five steps

  1. 1

    Obtain credentials

    Request an AWS Cognito client ID for your tenant from the SiriusPot operations team. All API access is scoped to your tenantId.

  2. 2

    Authenticate

    Exchange your credentials for a JWT access token via the Cognito OAuth token endpoint. Pass it as a Bearer token in the Authorization header.

  3. 3

    Opt players in

    Before accepting contributions for a player, register their consent with POST /v1/opt-in including the consentVersion they accepted.

  4. 4

    Send contributions

    For each qualifying bet, send POST /v1/contributions with a unique idempotencyKey. The engine splits the contribution across configured tiers.

  5. 5

    Subscribe to real-time events

    Open an SSE stream (GET /v1/events) for live pool counters, the public winner feed, and operator trigger notifications.

Base URLs

EnvironmentREST APIReal-time (SSE)
Local developmenthttp://localhost:3000http://localhost:3000/v1/events
Docker networkhttp://siriuscore:3000http://siriuscore:3000/v1/events

Conventions

  • Money: all monetary values are integers in cents (MoneyInCents) to avoid floating-point issues. R$ 100.00 is represented as 10000.
  • Timestamps: ISO-8601 strings in UTC (2026-08-06T14:30:00.000Z).
  • Identifiers: UUID v7 (time-ordered) for all resource IDs.
  • Tenancy: every request is scoped by tenantId. Tokens are validated against the tenant claim — you can only access your own tenant’s resources.
  • Pagination: list endpoints return a PaginatedResponse envelope with data and pagination keys.