Shockball Data API Documentation

Interactive API documentation for third-party developers

Quick Start Guide

1. Obtain an API Key

Contact the Shockball administration team at swctholmeso@gmail.com to request API access. API keys are prefixed with sb_live_ for production.

2. Authenticate Your Requests

Include your API key in requests using one of these methods:

// Using x-api-key header
x-api-key: sb_live_your_key_here
// Using Authorization Bearer
Authorization: Bearer sb_live_your_key_here

3. Try It Out

Use the interactive "Try it out" feature below to test endpoints directly. Click "Authorize" button, enter your API key, and execute requests.

Rate Limits

100 requests per hour per API key. Monitor X-RateLimit-* headers.

Current Version

API v1.0.0 - Stable release with 6+ month deprecation policy.

Support

Questions? Contact swctholmeso@gmail.com

Common Use Cases

Polling for Upcoming Matches

Fetch upcoming matches:

GET /api/v1/data/matches/upcoming?limit=20&competitionType=LEAGUE

Fetching Recent Results

Get completed matches with scores to settle bets:

GET /api/v1/data/matches/recent?limit=50&offset=0

Handling Pagination

Use offset to paginate through results. Check meta.hasMore to determine if more pages exist.

Rate Limit Handling

Implement exponential backoff when receiving HTTP 429 responses. Use X-RateLimit-Reset header to schedule retry.

Frequently Asked Questions

How do I get an API key?

Contact the Shockball administration team at swctholmeso@gmail.com to request API access. Include your use case and expected request volume.

What's the rate limit?

All endpoints are limited to 100 requests per hour per API key. Rate limit information is included in response headers (X-RateLimit-*).

How do I handle errors?

All errors return JSON with error, statusCode, and timestamp fields. Check the OpenAPI specification below for detailed error response formats.

Can I use this for commercial purposes?

Contact the Shockball team to discuss commercial API usage terms and pricing.

How long are API versions supported?

API versions are supported for a minimum of 6 months after deprecation announcement. Deprecated endpoints include Deprecation and Sunset headers.

Shockball Data API v1.0.0 | Last updated: October 2025