Documentation

API

Overview

Reach TopicLoops programmatically over HTTP — what the API covers, and what it costs.


What the API gives you

The TopicLoops API exposes topic-graph generation over plain HTTP, so you can build maps from your own tooling instead of the web app. You submit a keyword, poll until the graph is ready, and get back the same nested structure the Sunburst and Tree views draw.

It lives on its own host, separate from the app you are reading:

https://api.topicloops.com/v1

Your first request

Every request carries your key as a bearer token. This one asks the API what your account currently has available — it costs nothing and is the quickest way to confirm a key works:

curl -X GET \
     -H "Authorization: Bearer YOUR_API_KEY" \
     --compressed \
     https://api.topicloops.com/v1/account

A working key answers with your credit balance. Anything else means the key is missing, wrong, or not entitled — see Errors & rate limits.

Credits

API usage is metered in credits, which are included with your subscription and replenished on the 1st of each month while it stays active. Credits are counted per account, so every key you hold draws on the same balance.

Creating a topic graph costs 1 credit. Reading one back, looking up locations, and checking your account are all free. Call GET /account to read the balance at any time.

Conventions

  • Requests and responses are JSON. GET takes URL parameters; POST takes a JSON body with Content-Type: application/json.
  • Response keys are snake_case.
  • Numbers and booleans are real JSON numbers and booleans — never "4.6" or "true".
  • Dates are ISO 8601 strings in UTC, such as "2022-02-25T10:30:15.000Z".