# Twitch Live

## Overview

| Property | Value |
|----------|-------|
| **Status** | private |
| **Method** | `GET` |
| **Endpoint** | `/v2/twitch/live` |
| **Base URL** | `https://api.piloterr.com` |
| **Credit Cost** | 1 credit per call |
| **Documentation** | https://www.piloterr.com/library/twitch-live |

## Description

Gain real-time insights into Twitch streams with our API, including titles, descriptions, and live status updates.

## Authentication

- **Key Name:** `x-api-key`
- **Location:** HTTP Header
- **Get an API key:** https://app.piloterr.com/register

## Example Request

```bash
curl --location --request GET 'https://api.piloterr.com/v2/twitch/live' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'
```

## Example Response

### Example

```json
{
  "tags": [
    "Super Mario Maker 2",
    "Just Chatting",
    "League of Legends"
  ],
  "title": "Kamet0 - Twitch",
  "is_live": true,
  "viewers": null,
  "streamer": "Kamet0",
  "description": "Kamet0 streams live on Twitch! Check out their videos, sign up to chat, and join their community.",
  "total_views": null,
  "followers_count": null
}
```

## Documentation

## Overview
Gain real-time insights into Twitch streams with our API, including titles, descriptions, and live status updates.

## Quickstart
```
GET https://api.piloterr.com/v2/twitch/live?query=example
```

## Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| `query` | string | yes | Search query or target identifier |

## Main use cases
- Integrate Twitch Live data into enrichment, analytics, and monitoring pipelines
- Automate large-scale extraction from Twitch without maintaining scrapers
- Power internal dashboards and workflow automations with live Twitch data