Step 1: Request API Access

The first step is to request API access. Contact us at contact@alivator.com and let us know about your use case.

What to include in your request:

Your name and company
Use case description
Expected API request volume
Data categories needed

Step 2: Receive Your API Key

After onboarding, you'll receive an API key. Keep this key secure and never share it publicly.

Important:

Store your API key in environment variables. Never hardcode it in your application.

Step 3: Make Your First Request

Use curl to retrieve the list of available events:

Example Request

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.alivator.com/v1/events

Step 4: Parse the Response

The API returns JSON responses with event data:

Example Response

{
  "data": [
    {
      "id": "evt_1001",
      "category": "sports",
      "name": "World Cup Final",
      "status": "active",
      "probability": 0.75,
      "timestamp": "2026-01-15T14:30:00Z"
    },
    {
      "id": "evt_1002",
      "category": "weather",
      "name": "Hurricane Season Start",
      "status": "active",
      "probability": 0.62,
      "timestamp": "2026-01-15T14:30:00Z"
    }
  ],
  "meta": {
    "total": 2,
    "timestamp": "2026-01-15T14:30:00Z"
  }
}

Step 5: Filter by Category

Filter events by category to get specific data types:

Filtered Request

curl -H "Authorization: Bearer YOUR_API_KEY" \
  "https://api.alivator.com/v1/events?category=sports&limit=10"

Parameter	Type	Description
`category`	`string`	Filter by data category (sports, weather, economic, crypto, news)
`limit`	`integer`	Maximum number of results to return (default: 20, max: 100)
`status`	`string`	Filter by status (active or closed)

Next Steps

• Check out our First Request guide for language-specific examples
• Review the REST API reference for all endpoints
• Explore common use cases for inspiration
• Contact support at contact@alivator.com for questions