Quick start
[What the API lets you do, in one sentence.] You need an account and an API key.
1. Get your API key
[Where to create an API key, and how keys are scoped and revoked.]
2. Make your first call
[How to send your key with each request.]
curl https://api.[domain]/v1/[endpoint] \
-H "Authorization: Bearer [YOUR_API_KEY]" 3. Read the response
[What the response contains, in one sentence.]
{
"data": [
{
"id": "[id]",
"[field]": "[value]",
"[field]": "[value]"
}
]
} Authentication
[The credential model, permissions, key rotation, and security guidance.]
Endpoints
[One line per endpoint group.]
| Endpoint | What it does |
|---|---|
| [METHOD] /v1/[endpoint] | [What this endpoint returns or changes.] |
| [METHOD] /v1/[endpoint] | [What this endpoint returns or changes.] |
| [METHOD] /v1/[endpoint] | [What this endpoint returns or changes.] |
| [METHOD] /v1/[endpoint] | [What this endpoint returns or changes.] |
| [METHOD] /v1/[endpoint] | [What this endpoint returns or changes.] |
| [METHOD] /v1/[endpoint] | [What this endpoint returns or changes.] |
Webhooks
[The event delivery model and retry behavior, if supported.]
Rate limits
[Requests allowed per minute, and what happens when you go over.]
Errors
[Status codes, what each means, and what to do about it.]
Changelog
[Versioned API changes, each with its effective date.]
Newsletter360
See what your market is telling you.
Market signals, marketing ideas, and news from us, straight to your inbox.