OpenAPI

8BALL publishes an OpenAPI 3 specification for the public Developer API. It describes every supported route, request body, response shape, and error format.

Use the interactive explorer to try endpoints, or download the JSON spec for Postman, Insomnia, Bruno, or code generation.

Endpoints

SurfaceURL
Interactive explorerapi.8ball.live/openapi
OpenAPI JSON specapi.8ball.live/openapi/json

Import the JSON URL directly into your API client:

curl -sS https://api.8ball.live/openapi/json | jq '.info'

Expected title: 8BALL Developer API.

What is included

  • OAuth token and revoke routes
  • All public /v1/* REST endpoints (users, channels, categories, livestreams, chat, moderation, events)
  • Standard error response shapes

The guides on this site cover authentication flows, scopes, and webhook verification in more detail than the spec alone.

Try authenticated requests

Most /v1 routes require a Bearer token:

  1. Create an app in the developer console.
  2. Generate an API key or complete the OAuth flow to obtain an access token.
  3. In the explorer or your HTTP client, set Authorization: Bearer <token>.

OAuth token exchange uses client credentials — see OAuth 2.1.

Staying up to date

The OpenAPI spec is generated from the live API and updates when new endpoints ship. If you notice a difference between a guide and the spec, trust the spec at api.8ball.live/openapi/json.