Skip to main content
Glama

Get series data

get_series
Read-onlyIdempotent

Rows selected by a range of positions, dates or timestamps, as JSON or CSV.

REST operation: GET /api/series/{series}/{index}.

Input Schema

NameRequiredDescriptionDefault
endNoExclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end.
indexYes
limitNoMaximum number of values to return; with `end` too, the tighter of the two applies. Omitted, the rest of the range.
startNoInclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end.
formatNo
seriesYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed25 schema fields changed
    • removedInput schema / $defs / Format / description
      Removed value: -"Output format for API responses"
    • changedInput schema / $defs / Index / description
      Previous value: -"Aggregation dimension for querying series. Includes time-based (date, week, month, year),\nblock-based (height, tx_index), and address/output type indexes."New value: +"Aggregation dimension for querying series. Includes time-based (date, week, month, year), block-based (height, tx_index), and address/output type indexes."
    • changedInput schema / $defs / Index / enum
      Previous value: -[
      -  "minute10",
      -  "minute30",
      -  "hour1",
      -  "hour4",
      -  "hour12",
      -  "day1",
      -  "day3",
      -  "week1",
      -  "month1",
      -  "month3",
      -  "month6",
      -  "year1",
      -  "year10",
      -  "halving",
      -  "epoch",
      -  "height",
      -  "tx_index",
      -  "txin_index",
      -  "txout_index",
      -  "empty_output_index",
      -  "op_return_index",
      -  "p2a_addr_index",
      -  "p2ms_output_index",
      -  "p2pk33_addr_index",
      -  "p2pk65_addr_index",
      -  "p2pkh_addr_index",
      -  "p2sh_addr_index",
      -  "p2tr_addr_index",
      -  "p2wpkh_addr_index",
      -  "p2wsh_addr_index",
      -  "unknown_output_index",
      -  "funded_addr_index",
      -  "empty_addr_index",
      -  "extended_empty_addr_index"
      -]New value: +[
      +  "minute10",
      +  "minute30",
      +  "hour1",
      +  "hour4",
      +  "hour12",
      +  "day1",
      +  "day3",
      +  "week1",
      +  "month1",
      +  "month3",
      +  "month6",
      +  "year1",
      +  "year10",
      +  "halving_epoch",
      +  "difficulty_epoch",
      +  "height",
      +  "tx_index",
      +  "txin_index",
      +  "txout_index",
      +  "empty_script_output_index",
      +  "op_return_output_index",
      +  "p2a_address_index",
      +  "p2ms_output_index",
      +  "p2pk33_address_index",
      +  "p2pk65_address_index",
      +  "p2pkh_address_index",
      +  "p2sh_address_index",
      +  "p2tr_address_index",
      +  "p2wpkh_address_index",
      +  "p2wsh_address_index",
      +  "unknown_script_output_index"
      +]
    • changedInput schema / $defs / Limit / description
      Previous value: -"Maximum number of results to return. Defaults to 100 if not specified."New value: +"Maximum number of results to return; each parameter states what omitting it means."
    • removedInput schema / $defs / Limit / format
      Removed value: -"uint"
    • changedInput schema / $defs / RangeIndex / anyOf
      Previous value: -[
      -  {
      -    "examples": [
      -      0,
      -      -366
      -    ],
      -    "format": "int64",
      -    "type": "integer"
      -  },
      -  {
      -    "examples": [
      -      "2025-08-15"
      -    ],
      -    "format": "date",
      -    "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      -    "type": "string"
      -  },
      -  {
      -    "examples": [
      -      "2025-08-15T00:00:00Z"
      -    ],
      -    "format": "date-time",
      -    "type": "string"
      -  }
      -]New value: +[
      +  {
      +    "examples": [
      +      0,
      +      -366
      +    ],
      +    "type": "integer"
      +  },
      +  {
      +    "examples": [
      +      "2025-08-15"
      +    ],
      +    "format": "date",
      +    "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      +    "type": "string"
      +  },
      +  {
      +    "examples": [
      +      "2025-08-15T00:00:00Z"
      +    ],
      +    "format": "date-time",
      +    "type": "string"
      +  }
      +]
    • removedInput schema / $defs / SeriesName / description
      Removed value: -"Series name"
    • addedInput schema / $defs / SeriesName / pattern
      Added value: +"^[a-z0-9_]+$"
    • changedInput schema / properties / end / description
      Previous value: -"Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e`"New value: +"Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end."
    • removedInput schema / properties / format / description
      Removed value: -"Format of the output"
    • removedInput schema / properties / index / description
      Removed value: -"Aggregation index"
    • changedInput schema / properties / limit / description
      Previous value: -"Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l`"New value: +"Maximum number of values to return; with `end` too, the tighter of the two applies. Omitted, the rest of the range."
    • removedInput schema / properties / series / description
      Removed value: -"Series name"
    • changedInput schema / properties / start / description
      Previous value: -"Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s`"New value: +"Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end."
    • changedOutput schema / $defs / Index / enum
      Previous value: -[
      -  "minute10",
      -  "minute30",
      -  "hour1",
      -  "hour4",
      -  "hour12",
      -  "day1",
      -  "day3",
      -  "week1",
      -  "month1",
      -  "month3",
      -  "month6",
      -  "year1",
      -  "year10",
      -  "halving",
      -  "epoch",
      -  "height",
      -  "tx_index",
      -  "txin_index",
      -  "txout_index",
      -  "empty_output_index",
      -  "op_return_index",
      -  "p2a_addr_index",
      -  "p2ms_output_index",
      -  "p2pk33_addr_index",
      -  "p2pk65_addr_index",
      -  "p2pkh_addr_index",
      -  "p2sh_addr_index",
      -  "p2tr_addr_index",
      -  "p2wpkh_addr_index",
      -  "p2wsh_addr_index",
      -  "unknown_output_index",
      -  "funded_addr_index",
      -  "empty_addr_index",
      -  "extended_empty_addr_index"
      -]New value: +[
      +  "minute10",
      +  "minute30",
      +  "hour1",
      +  "hour4",
      +  "hour12",
      +  "day1",
      +  "day3",
      +  "week1",
      +  "month1",
      +  "month3",
      +  "month6",
      +  "year1",
      +  "year10",
      +  "halving_epoch",
      +  "difficulty_epoch",
      +  "height",
      +  "tx_index",
      +  "txin_index",
      +  "txout_index",
      +  "empty_script_output_index",
      +  "op_return_output_index",
      +  "p2a_address_index",
      +  "p2ms_output_index",
      +  "p2pk33_address_index",
      +  "p2pk65_address_index",
      +  "p2pkh_address_index",
      +  "p2sh_address_index",
      +  "p2tr_address_index",
      +  "p2wpkh_address_index",
      +  "p2wsh_address_index",
      +  "unknown_script_output_index"
      +]
    • removedOutput schema / $defs / SeriesData / properties / end / format
      Removed value: -"uint"
    • addedOutput schema / $defs / SeriesData / properties / index / $ref
      Added value: +"#/$defs/Index"
    • removedOutput schema / $defs / SeriesData / properties / index / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/Index"
      -  }
      -]
    • removedOutput schema / $defs / SeriesData / properties / stamp
      Removed value: -{
      -  "type": "string"
      -}
    • removedOutput schema / $defs / SeriesData / properties / start / format
      Removed value: -"uint"
    • removedOutput schema / $defs / SeriesData / properties / version / allOf
      Removed value: -[
      -  {
      -    "$ref": "#/$defs/Version"
      -  }
      -]
    • addedOutput schema / $defs / SeriesData / properties / version / minimum
      Added value: +0
    • addedOutput schema / $defs / SeriesData / properties / version / type
      Added value: +"integer"
    • changedOutput schema / $defs / SeriesData / required
      Previous value: -[
      -  "version",
      -  "index",
      -  "start",
      -  "end",
      -  "stamp",
      -  "data"
      -]New value: +[
      +  "version",
      +  "index",
      +  "start",
      +  "end",
      +  "data"
      +]
    • removedOutput schema / $defs / Version
      Removed value: -{
      -  "format": "uint32",
      -  "minimum": 0,
      -  "type": "integer"
      -}
  2. First observed

TDQS

C2.9/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint, so the safety profile is covered. The description adds only that output can be JSON or CSV, which merely echoes the format enum in the schema; it says nothing about volume, pagination, or the cost of wide ranges.

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?

Two short sentences plus a route line, with the ranged-row behavior front-loaded and zero filler. The REST operation line is useful for agents mapping to the underlying API.

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

Completeness2/5

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

Six parameters, half of them undocumented in the schema, an output schema present, and a crowded set of get_series_* siblings — yet the description explains neither the series/index semantics nor why this variant should be chosen. It is too thin for the surface area.

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

Parameters4/5

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

Schema coverage is 50%, but the description does real work by explaining that the range can be expressed as positions, dates, or timestamps, which is exactly the anyOf meaning of start/end. It stops short of covering series name, index aggregation, or how limit interacts with end.

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

Purpose3/5

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

The description says it returns "Rows selected by a range of positions, dates or timestamps, as JSON or CSV," which conveys a ranged-read of series data, and the REST route GET /api/series/{series}/{index} pins the resource. However, it never says what a "series" value actually is, and it draws no distinction from close siblings like get_series_bulk, get_series_latest, or get_series_len.

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

Usage Guidelines2/5

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

There is no when-to-use guidance at all — no statement about choosing a bounded range versus the bulk, latest, or count variants that sit right next to it in the tool list. The agent must infer selection from the name alone.

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.