Skip to content
Terminal

Quotas

Limits below are the numbers in the plan catalog. GET /v1/account returns the calling account's limits. GET /v1/usage returns this month's calls, today's previews, notes, and the credit balance.

Plans

Free, Trader, Pro, and Community are the plans in the catalog. You can get a paid plan only while paid plans are open. Plans says whether they are. Community's API numbers match Trader, except fair use is 2,000 notes a month, and it has 10 channel destinations. Its webhook destination limit is 0.

notes_per_month is 10 on Free and null on Trader and Pro. Null means a note on each alert. notes_fair_use_per_month is null on Free, 1,000 on Trader, and 2,000 on Pro. Fair use pauses new notes after that count for the UTC month.

The check interval is how often Terminal evaluates conditions on that plan. Delivery to software is best effort.

Credits, blocks, and caps

Balances and prices are cents. A credit balance of 0 means no credits are on the account.

One block is 1,000 API calls past the month's included calls, and costs 10 cents. Calls already inside the included count do not open a block. A new month starts the counter at 0. Blocks do not carry over.

A preview past the day's included previews costs 2 cents. On Free, an explanation past notes_per_month costs 5 cents from credits. On Trader and Pro, an explanation past the fair-use count is not charged: the answer has the measured facts and no note, with note.reason paused.

The key's daily cap defaults to 500 cents ($5) and can be set from 0 to 10,000 cents ($100), in whole dollars. 0 means that key does not spend credits. The account's monthly API spend cap defaults to 2,000 cents ($20) and can be raised to 50,000 cents ($500). A refused charge does not move the balance.

What counts as a call

A /v1 request counts as one call when Terminal has accepted the key, the channel, the rate limit, the scope, the idempotency check, and the body, and then runs the request.

These answers do not count: 401 invalid_key, 503 not_available, 403 terms_required, 429 rate_limited, 403 scope_missing, 400 validation_failed, 404 for an unknown route, and an idempotency replay or conflict.

A 402 caused by that call's own block or preview charge is given back. A 500 is given back. Other answers from the handler count, including a 404 for a missing id and a 409 for a duplicate rule.

GET /v1/events counts only when the answer contains at least one event. An empty page is free, including a long-poll that ends with no event. Rate limits still count every request. See Rate limits.

This month and today

usage.month.calls is the counted calls this UTC month. included_calls is the plan's monthly inclusion. blocks is the highest block opened this month. block_calls is 1,000. block_price_cents is 10. api_spent_cents is API credit spend this month. monthly_spend_cap_cents is the account cap.

usage.today.previews is previews used today. included_previews is the day's allowance. key_spent_cents and key_daily_cap_cents are this key's spend and cap for the UTC day.

usage.notes.included is notes_per_month. fair_use is the fair-use cap. usage.credits.balance_cents is the ledger balance.

Example. These are not live prices.

GET /v1/usage HTTP/1.1
Authorization: Bearer $TERMINAL_API_KEY

HTTP/1.1 200 OK
{
  "usage": {
    "month": {
      "start": "…",
      "resets_at": "…",
      "calls": "…",
      "included_calls": 200000,
      "blocks": 0,
      "block_calls": 1000,
      "block_price_cents": 10,
      "api_spent_cents": 0,
      "monthly_spend_cap_cents": 2000
    },
    "today": {
      "day": "…",
      "resets_at": "…",
      "previews": 0,
      "included_previews": 200,
      "key_spent_cents": 0,
      "key_daily_cap_cents": 500
    },
    "notes": {
      "used_this_month": 0,
      "included": null,
      "fair_use": 2000
    },
    "credits": { "balance_cents": 0 }
  }
}

Create a free account

All developer pages

Terminal reports market events for conditions you set. It does not tell you to buy, sell, or hold, and it does not place trades.