Skip to main content
Glama

reference-data

get_series_history

Read-onlyIdempotent

PAID ($0.003). Historical values of a reference series with effective date ranges, optionally filtered by from/to (YYYY-MM-DD). Pass api_key if you have one (instant card checkout at /pricing); otherwise the response explains how to pay via x402. Every US series is free to try. After a 200, bind get_changes (free poll) or register_alert (HMAC push; Register: $0 · Delivery after trial: $0.05) on this series so a later gazette does not silently retire the value.

Input Schema

NameRequiredDescriptionDefault
toNoLatest effective date, YYYY-MM-DD
fromNoEarliest effective date, YYYY-MM-DD
seriesYesSeries id
api_keyNoAPI key
countryYesISO country code

Output Schema

NameRequiredDescriptionDefault
errorNoPresent on a free refusal or error; no charge
staleNo
seriesNo
countryNo
entriesNo
no_chargeNo
price_usdNo
disclaimerNo
how_to_payNo
bind_seriesNo
explanationNo
label_basisNoInputs and the rule ids that produced the two labels
x_next_bindNo
http_endpointNo
coverage_labelNoHow much of the question is covered: ready = complete; partial = held with a disclosed limitation or default; gap = no number served. Rules at /label-rules
confidence_labelNoEvidence verdict derived from source type, verification age and the stale flag (answers: the weakest series read). Rules at /label-rules
payment_requiredNotrue when the call needs payment; how_to_pay explains x402 or card

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • removedOutput schema / properties / entries / items / properties / label_basis / properties / source_type / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / entries / items / properties / label_basis / properties / source_type / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / entries / items / properties / label_basis / properties / verification_age_days / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / entries / items / properties / label_basis / properties / verification_age_days / type
      Added value: +[
      +  "number",
      +  "null"
      +]
    • removedOutput schema / properties / label_basis / properties / source_type / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / label_basis / properties / source_type / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / label_basis / properties / verification_age_days / anyOf
      Removed value: -[
      -  {
      -    "type": "number"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / label_basis / properties / verification_age_days / type
      Added value: +[
      +  "number",
      +  "null"
      +]
  2. Changed7 schema fields changed
    • changedOutput schema / description
      Previous value: -"Historical entries of one series"New value: +"Historical entries of one series; top-level labels describe the current value, and each entry carries its own"
    • addedOutput schema / properties / confidence_label
      Added value: +{
      +  "description": "Evidence verdict derived from source type, verification age and the stale flag (answers: the weakest series read). Rules at /label-rules",
      +  "enum": [
      +    "high",
      +    "medium",
      +    "low"
      +  ],
      +  "type": "string"
      +}
    • addedOutput schema / properties / coverage_label
      Added value: +{
      +  "description": "How much of the question is covered: ready = complete; partial = held with a disclosed limitation or default; gap = no number served. Rules at /label-rules",
      +  "enum": [
      +    "ready",
      +    "partial",
      +    "gap"
      +  ],
      +  "type": "string"
      +}
    • addedOutput schema / properties / entries / items / additionalProperties
      Added value: +{}
    • addedOutput schema / properties / entries / items / properties
      Added value: +{
      +  "confidence": {},
      +  "confidence_label": {
      +    "description": "Evidence verdict derived from source type, verification age and the stale flag (answers: the weakest series read). Rules at /label-rules",
      +    "enum": [
      +      "high",
      +      "medium",
      +      "low"
      +    ],
      +    "type": "string"
      +  },
      +  "country": {
      +    "type": "string"
      +  },
      +  "coverage_label": {
      +    "description": "How much of the question is covered: ready = complete; partial = held with a disclosed limitation or default; gap = no number served. Rules at /label-rules",
      +    "enum": [
      +      "ready",
      +      "partial",
      +      "gap"
      +    ],
      +    "type": "string"
      +  },
      +  "effective_from": {},
      +  "label_basis": {
      +    "additionalProperties": {},
      +    "description": "Inputs and the rule ids that produced the two labels",
      +    "properties": {
      +      "confidence_reasons": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "coverage_reasons": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "inputs": {
      +        "items": {},
      +        "type": "array"
      +      },
      +      "rules": {
      +        "type": "string"
      +      },
      +      "rules_version": {
      +        "type": "string"
      +      },
      +      "source_type": {
      +        "anyOf": [
      +          {
      +            "type": "string"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      },
      +      "stale": {
      +        "type": "boolean"
      +      },
      +      "verification_age_days": {
      +        "anyOf": [
      +          {
      +            "type": "number"
      +          },
      +          {
      +            "type": "null"
      +          }
      +        ]
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "last_confirmed": {},
      +  "notes": {},
      +  "series": {
      +    "type": "string"
      +  },
      +  "source": {},
      +  "stale": {
      +    "type": "boolean"
      +  },
      +  "unit": {},
      +  "value": {}
      +}
    • addedOutput schema / properties / entries / items / type
      Added value: +"object"
    • addedOutput schema / properties / label_basis
      Added value: +{
      +  "additionalProperties": {},
      +  "description": "Inputs and the rule ids that produced the two labels",
      +  "properties": {
      +    "confidence_reasons": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "coverage_reasons": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "inputs": {
      +      "items": {},
      +      "type": "array"
      +    },
      +    "rules": {
      +      "type": "string"
      +    },
      +    "rules_version": {
      +      "type": "string"
      +    },
      +    "source_type": {
      +      "anyOf": [
      +        {
      +          "type": "string"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    },
      +    "stale": {
      +      "type": "boolean"
      +    },
      +    "verification_age_days": {
      +      "anyOf": [
      +        {
      +          "type": "number"
      +        },
      +        {
      +          "type": "null"
      +        }
      +      ]
      +    }
      +  },
      +  "type": "object"
      +}
  3. Changed1 schema field changed
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "description": "Historical entries of one series",
      +  "properties": {
      +    "bind_series": {},
      +    "country": {
      +      "type": "string"
      +    },
      +    "disclaimer": {},
      +    "entries": {
      +      "items": {},
      +      "type": "array"
      +    },
      +    "error": {
      +      "description": "Present on a free refusal or error; no charge"
      +    },
      +    "explanation": {},
      +    "how_to_pay": {
      +      "items": {
      +        "type": "string"
      +      },
      +      "type": "array"
      +    },
      +    "http_endpoint": {
      +      "type": "string"
      +    },
      +    "no_charge": {
      +      "type": "boolean"
      +    },
      +    "payment_required": {
      +      "description": "true when the call needs payment; how_to_pay explains x402 or card",
      +      "type": "boolean"
      +    },
      +    "price_usd": {
      +      "type": "number"
      +    },
      +    "series": {
      +      "type": "string"
      +    },
      +    "stale": {
      +      "type": "boolean"
      +    },
      +    "x_next_bind": {}
      +  },
      +  "type": "object"
      +}
  4. Changed1 schema field changed
    • changedInput schema / properties / country / enum
      Previous value: -[
      -  "ca",
      -  "cr",
      -  "do",
      -  "gt",
      -  "hn",
      -  "mx",
      -  "pa",
      -  "sv",
      -  "us"
      -]New value: +[
      +  "bs",
      +  "ca",
      +  "cr",
      +  "do",
      +  "gt",
      +  "hn",
      +  "mx",
      +  "pa",
      +  "sv",
      +  "us"
      +]
  5. Changed1 schema field changed
    • changedInput schema / properties / country / enum
      Previous value: -[
      -  "ca",
      -  "mx",
      -  "us"
      -]New value: +[
      +  "ca",
      +  "cr",
      +  "do",
      +  "gt",
      +  "hn",
      +  "mx",
      +  "pa",
      +  "sv",
      +  "us"
      +]
  6. Changed1 schema field changed
    • changedInput schema / properties / country / enum
      Previous value: -[
      -  "ca",
      -  "us"
      -]New value: +[
      +  "ca",
      +  "mx",
      +  "us"
      +]
  7. First observed

TDQS

A4.1/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnly/idempotent/non-destructive, and the description layers on substantial extra context the annotations cannot convey: pricing ($0.003), the payment/auth mechanics (api_key vs x402), the free US trial, and the silent-retirement risk that motivates binding a follow-up.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads price and purpose before the payment and follow-up details, and each sentence carries information. However the final sentence crams get_changes, register_alert, HMAC, and two price points into one long clause, making it denser than it needs to be.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, return values need no explanation. For a paid, multi-param read tool the description covers payment, auth, filtering, trial scope, and lifecycle follow-up – everything an agent needs to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so country/series/from/to are already fully documented, and the description's 'YYYY-MM-DD' simply repeats the schema. The one additive note is that api_key is optional ('if you have one'), which approaches a 4 but is thin against otherwise redundant parameter text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource: 'Historical values of a reference series with effective date ranges, optionally filtered by from/to.' Clear what it retrieves, though it never explicitly contrasts itself with close siblings like get_series or get_snapshot, leaving the agent to infer the distinction.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives clear operational context: pass api_key if you have one, otherwise the response explains x402 payment, and 'every US series is free to try.' It also routes the agent to follow-ups (get_changes, register_alert) after a 200. It stops short of saying explicitly when to pick this over get_series/get_snapshot.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources