# Talkwalker

> Talkwalker is a social media analytics and listening platform. Its REST API covers search over
> indexed mentions, real-time streaming, histogram aggregates that reproduce dashboard widgets,
> document and review import, project resource management, and image detection. Talkwalker was
> acquired by Hootsuite and is being rebranded "Lumen by Talkwalker"; the API, host and developer
> portal still carry the Talkwalker name.

Generated by API Evangelist on 2026-08-13. Method: generated (Talkwalker publishes no llms.txt of
its own — https://www.talkwalker.com/llms.txt returns HTTP 200 carrying the placeholder string
"No llmsTxt content"). Source: https://developer.talkwalker.com/ and Talkwalker's own published
OpenAPI at https://developer.talkwalker.com/talkwalker-api.yaml.

## How to call it

- Base URL: https://api.talkwalker.com
- Auth: an API key in the QUERY STRING — `?access_token=<token>`. No Authorization header. Two
  rights levels: `read_only` (search) and `read_write` (search plus document, stream, panel and rule
  writes). Tokens are issued by Talkwalker on request; there is no self-service signup.
- Try it without a token: `access_token=demo` works on the non-project search, histogram and
  streaming endpoints, for the queries `cats`, `dogs` or `cats AND dogs` only, returning
  blogs/forums/news only.
- Three path versions are live at once and carry DIFFERENT surfaces: /api/v1 (search, summary,
  histogram, credits), /api/v2 (documents, resources, topics, panels, custom metrics, images),
  /api/v3 (streaming, collectors, export tasks).
- Every response is a flat vendor envelope: `status_code` (a numeric STRING, independent of the HTTP
  status), `status_message`, `request`, `request_id`. Branch on `status_code`, not only on HTTP.
- Metering is credits: Search 1/result + a 10-credit call floor; Streaming 1/result; Histogram 10/call;
  import free. Balance: GET /api/v1/status/credits.
- No rate-limit response headers exist. Per-endpoint call-limit exhaustion returns HTTP 401 with
  `status_code` "8"; concurrent-stream exhaustion returns HTTP 429 with "30".
- No idempotency keys, no webhooks, no AsyncAPI, no MCP server, no A2A agent card, no /.well-known/
  documents, no first-party SDKs, no changelog.

## APIs

- [Search API](https://developer.talkwalker.com/docs/overview/search-api/search-results-project-api): Export documents from a project or the global index.
- [Histogram API](https://developer.talkwalker.com/docs/overview/search-api/search-histograms-project-api): Aggregates that reproduce dashboard widgets — the only export route for Facebook, Instagram, Reddit and TikTok.
- [Streaming API v3](https://developer.talkwalker.com/docs/overview/streaming-api-v3): Chunked-JSON real-time streams, resumable collectors, and past-data export tasks.
- [Resources API](https://developer.talkwalker.com/docs/overview/resources-api): Topics, tags, views, custom metrics and source panels on a project.
- [Documents API](https://developer.talkwalker.com/docs/overview/docs-api): Import and modify first-party documents and reviews.
- [Image API](https://developer.talkwalker.com/docs/overview/image-api): Logo, object and scene detection on images.
- [Status API](https://developer.talkwalker.com/api/status-api/status-credits): Credit and call consumption.

## Specs

- [OpenAPI 3.0.0, published by Talkwalker](https://developer.talkwalker.com/talkwalker-api.yaml): 42 paths, 50 operations. Ships no operationId on any operation.
- [Search (refined)](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/openapi/talkwalker-search-openapi.yml)
- [Histogram (refined)](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/openapi/talkwalker-histogram-openapi.yml)
- [Streaming (refined)](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/openapi/talkwalker-streaming-openapi.yml)
- [Resources (refined)](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/openapi/talkwalker-resources-openapi.yml)
- [Documents (refined)](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/openapi/talkwalker-documents-openapi.yml)
- [Image (refined)](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/openapi/talkwalker-image-openapi.yml)
- [Status (refined)](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/openapi/talkwalker-status-openapi.yml)

## Docs

- [Developer portal](https://developer.talkwalker.com/docs/)
- [API reference](https://developer.talkwalker.com/api/)
- [Access token](https://developer.talkwalker.com/docs/getting-started/access-token)
- [Credits / pricing](https://developer.talkwalker.com/docs/getting-started/credits-pricing)
- [API restrictions and rate limits](https://developer.talkwalker.com/docs/getting-started/api-restrictions)
- [Query syntax](https://developer.talkwalker.com/docs/query-syntax)
- [Document fields](https://developer.talkwalker.com/docs/talkwalker-documents/fields)
- [Error codes](https://developer.talkwalker.com/docs/troubleshooting/error-codes)
- [Error handling](https://developer.talkwalker.com/docs/troubleshooting/error-handling)
- [Status page](https://status.talkwalker.com/)

## What you cannot export

- Facebook and Instagram: no content via API; aggregated metrics only.
- X (Twitter): tweet ID, author ID and sentiment score only, capped at 1.5M docs/month/account
  without the X data add-on.
- Online news and TV Eyes: truncated for copyright; matched keywords are highlighted in
  `content_snippet`.
- LinkedIn, Weibo and other Chinese sources, Disqus, MONITOREDSITE, WEB_NLA: not exportable.
- Reddit and TikTok: raw documents not exportable; aggregates available via Histogram.
- Social media documents cannot be IMPORTED into Talkwalker.

## API Evangelist artifacts

- [apis.yml](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/apis.yml)
- [Authentication](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/authentication/talkwalker-authentication.yml)
- [Conventions](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/conventions/talkwalker-conventions.yml)
- [Error catalog](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/errors/talkwalker-problem-types.yml)
- [Rate limits](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/rate-limits/talkwalker-rate-limits.yml)
- [Lifecycle](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/lifecycle/talkwalker-lifecycle.yml)
- [Sandbox](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/sandbox/talkwalker-sandbox.yml)
- [Data model](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/data-model/talkwalker-data-model.yml)
- [Conformance](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/conformance/talkwalker-conformance.yml)
- [Plans and pricing](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/plans/talkwalker-plans-pricing.yml)
- [Agent skills](https://raw.githubusercontent.com/api-evangelist/talkwalker/refs/heads/main/skills/_index.yml)