Interactive Developer Console

Sports Data API Playground

Test HZURA's sports data API. Check health, discover available sports, browse events, inspect odds responses, and generate production-ready integration code.

Request API Access API Documentation
API Playground
Connection: Not tested
Health
Sports
Events
Event + Odds
GET
/api/v1/health

Connectivity check. Verifies the API gateway is alive. Does not require an API key or IP policy.

GET

/api/v1/health

Response

Select an endpoint to begin

Choose an endpoint above, configure parameters, then send a request.

Integration Code

curl -sS "https://api.hzura.com/api/v1/health" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

How the APIs Connect

From health check to production integration in five steps.

01

Health

Check service availability. Public endpoint, no IP policy required.

02

Sports

Discover which sports are available to this API client via GET /sports.

03

Events

Get the event catalog for the selected sport via GET /{sport}/events.

04

Event + Odds

Get one event and its currently available odds via GET /{sport}/events/{eventId}.

05

Integrate

Use the public API URL in your application. Refer to generated code examples.

Quick API Reference

Public API base and documented endpoints.

Full Documentation
Public API Base URL
https://api.hzura.com/api/v1

All integration requests use this base URL.

Authentication
API Key + IP CIDR

Send your API key via Authorization: Bearer or X-Api-Key. Your calling IP must also match a configured CIDR. Legacy IP-only access is also supported.

Protocol
HTTP GET · JSON Responses

Read-only REST. No query parameters in the current contract.

Documented Endpoints

GET
/api/v1/health
Public

Verifies API gateway availability. Does not require an API key or IP policy.

GET
/api/v1/sports
Authenticated

Returns sports available to the calling client.

GET
/api/v1/{sport}/events
Authenticated

Returns the event catalog for the specified sport.

GET
/api/v1/{sport}/events/{eventId}
Authenticated

Returns one event plus its currently available odds markets.

{sport} comes from the /sports endpoint response (key field).

{eventId} is the gmid from the event list.

Frequently Asked Questions

Common questions about the Sports Data API.

What is HZURA's Sports Data API Playground?

An interactive developer tool for testing HZURA's sports data API. Check health, discover available sports, browse events, inspect event and odds responses, and generate production code.

How does authentication work?

Admin-managed customers authenticate with an API key (Authorization: Bearer or X-Api-Key) and must call from an IP matching their configured CIDR. Legacy IP-only clients are also supported without a key.

How do I get event IDs to query odds?

Query GET /api/v1/{sport}/events to get events with their gmid values. Pass the gmid to GET /api/v1/{sport}/events/{eventId} for odds.

Does the API support WebSockets or live streaming?

No. The current API version provides HTTP GET endpoints returning cached data. There is no WebSocket or push feed. Clients should poll events they are interested in and stop polling when events are no longer needed.

Why might I receive a 403 or 429 error?

403 ip_not_allowed means the caller was not admitted: a missing, empty, or unknown API key, a disabled customer, or a calling IP outside the configured CIDR. The body does not say which check failed. 429 means the sports rate limit was exceeded — honour the Retry-After header before retrying. GET /api/v1/health is public and is not rate limited.

How do I request production API access?

Contact HZURA with your server's static public IP address. You will receive an API key and your IP will be configured for access.

Does the API have a separate result endpoint?

No. The current API does not have a separate result endpoint. Event status and outcome data are included in the event response when available.

Ready for Production

Request API Access

Contact HZURA to get your API key and configure your server's IP for access to sports, events, and odds data.

Request API Access Learn MoreAPI Documentation