Rates and curve

Treasury yields, spreads and the curve regime

Changed on

The yields board, the 2s10s and other spreads, and the current curve regime (bull or bear, steepener or flattener) with the time it flipped. Live on Pro and Ultimate; Free, Squawk and Starter get the same board 60 minutes behind for 1 credit and live for 5 with fresh=1; without a key the upgrade steps come instead of numbers.

get/v1/rates

Request

  • Base URL: https://api.helious.io
  • URL: https://api.helious.io/v1/rates
  • Auth: one of:
    • none
    • HTTP bearer

Query parameters

freshboolean

Not on Pro or Ultimate? Add fresh=1 to this request and this one call answers live (news, prints, auctions, boards and prices at the live instant) for 5 credits. Left out, Free, Squawk and Starter get the answer 60 minutes behind for 1 credit. With fewer than 5 credits left the live call is refused with out_of_credits and nothing is charged; the same call without the flag still answers for 1. Accepted and free on Pro and Ultimate, where the view is already live. Ignored without a key: a free account key has the flag. Over MCP the same flag is fresh: true in the tool's arguments.

Response

summary + source + data + meta envelope

summarystring

The answer as a sentence, with the numbers in it. Identical to the sentence the matching MCP tool returns.

dataobject

The dataset itself.

metaobject

When it was true, and what your plan allows.

plan_limitobject

Present only when your plan moved the window. Says this is a plan limit rather than missing data, what Helious holds behind it, and the exact step to relay to the person you work for.

Example response

{
  "source": {
    "name": "Helious",
    "cite_as": "Helious, https://helious.io/auctions"
  }
}

Changes

  • 06bada17ad7aRevision changes
    • info

      added the new optional query request parameter fresh

    • info

      added the non-success response with the status