> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tradingnews.press/llms.txt
> Use this file to discover all available pages before exploring further.

# API Overview

> Base URL, authentication, and response format

## Base URL

```
https://api.tradingnews.press
```

## Authentication

All endpoints require an API key via the `X-API-Key` header:

```bash theme={null}
curl -H "X-API-Key: tn_live_your_key" https://api.tradingnews.press/v1/news
```

## Response Format

All responses are JSON. Successful responses return `200`. Error responses include a `detail` field:

```json theme={null}
{ "detail": "Error description" }
```

## Article Schema

Every article returned by the API follows this structure:

| Field          | Type      | Description                                                                                                                                                                                |
| -------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `id`           | string    | Unique ULID, sortable by time                                                                                                                                                              |
| `content`      | string    | Article text (headline or full content)                                                                                                                                                    |
| `urgency`      | string    | `breaking`, `flash`, or `regular`                                                                                                                                                          |
| `sentiment`    | string?   | Sentiment label (when available)                                                                                                                                                           |
| `published_at` | string?   | ISO 8601 publication time                                                                                                                                                                  |
| `received_at`  | string    | ISO 8601 time TradingNews received the article                                                                                                                                             |
| `tickers`      | object\[] | **Max plan only.** Per-ticker sentiment for the article, e.g. `[{"ticker": "AAPL", "sentiment": "positive"}]`. Empty array when no tickers are detected. Absent for Starter/Pro responses. |

## Endpoints

| Method | Path                | Description                  | Access            |
| ------ | ------------------- | ---------------------------- | ----------------- |
| GET    | `/v1/news`          | List recent articles         | Starter, Pro, Max |
| GET    | `/v1/news/search`   | Semantic search over archive | Max only          |
| WS     | `/v1/stream`        | Real-time firehose stream    | Pro, Max          |
| GET    | `/v1/account/usage` | Check plan and rate limit    | All tiers         |
