finance.xbrl-frames

SEC EDGAR XBRL Frames — one financial concept reported by every public filer for a single period, for cross-company screening and comparison. Give an XBRL tag (e.g. Revenues, NetIncomeLoss, Assets), a unit (default USD), and a period (CY2023 for annual, CY2023Q1 for a quarter, CY2023Q4I for instant balance-sheet items), and get back every filer's value — company name, CIK, location, period start/end, and the reported value — sorted high to low (or asc). Returns the total filer count and the top N. Free, public-domain (SEC). Distinct from finance.company-facts (one company, many metrics): this is one metric across all companies. For ranking, peer comparison, and market-wide analysis.

price

$0.0022 USDC per call

method

GET/api/finance/xbrl-frames

payment

x402 v2 · USDC on Base (EIP-3009) or Solana (SPL transfer)

auth

None. Sign the payment, retry with PAYMENT-SIGNATURE.

tier

Tier 0 — no paid upstream

Parameters

Name	Type	Description
`tag`required	string	min 2 chars · max 80 chars
`period`required	string	match ^CY\d{4}(Q[1-4]I?)?$
`unit`	string	min 1 chars · max 20 chars
`taxonomy`	string	min 2 chars · max 20 chars
`sort`	string	one of: desc \| asc
`limit`	integer	min 1 · max 100

Code samples

cURLbash

# 1. Probe with no auth → 402 envelope with PaymentRequirements
curl -sS 'https://2s.io/api/finance/xbrl-frames?tag=xx&period=example&unit=example&taxonomy=xx&sort=desc&limit=1'

# 2. Sign + retry with PAYMENT-SIGNATURE:
curl -sS 'https://2s.io/api/finance/xbrl-frames?tag=xx&period=example&unit=example&taxonomy=xx&sort=desc&limit=1' \
  -H 'PAYMENT-SIGNATURE: <base64-json-payload>'

# Or use the canonical runner (handles probe → sign → retry):
#   EVM_PRIVATE_KEY=0x... node --env-file=.env.local \
#     --experimental-strip-types scripts/x402-pay.ts \
#     'https://2s.io/api/finance/xbrl-frames?tag=xx&period=example&unit=example&taxonomy=xx&sort=desc&limit=1'

TypeScript / Node — @2sio/sdktypescript

import { TwoS } from '@2sio/sdk'

const client = new TwoS({
  privateKey: process.env.EVM_PRIVATE_KEY as `0x${string}`,
})

const result = await client.finance.xbrlFrames({
  "tag": "xx",
  "period": "example",
  "unit": "example",
  "taxonomy": "xx",
  "sort": "desc",
  "limit": 1
})

console.log('endpoint:', result.endpoint)
console.log('cost:', result.costUsd, 'USDC')
console.log('tx:', result.settlement?.txHash)
console.log('data:', result.data)

Python — 2siopython

import os
from twosio import TwoS

client = TwoS(private_key=os.environ["EVM_PRIVATE_KEY"])

result = client.finance.xbrl_frames(tag="xx", period="example", unit="example", taxonomy="xx", sort="desc", limit=1)

print("endpoint:", result.endpoint)
print("cost:", result.cost_usd, "USDC")
print("tx:", (result.settlement or {}).get("tx_hash"))
print("data:", result.data)

MCP — Claude Desktop / AgentKit / any MCP hostjson

// 1. Add @2sio/mcp to your MCP host config (Claude Desktop example below).
//    EVM_PRIVATE_KEY funds x402 payments per call.

// claude_desktop_config.json
{
  "mcpServers": {
    "2sio": {
      "command": "npx",
      "args": ["-y", "@2sio/mcp"],
      "env": { "EVM_PRIVATE_KEY": "0x..." }
    }
  }
}

// 2. Once the server is running, agents call this tool via standard MCP:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "finance.xbrl-frames",
    "arguments": {
      "tag": "xx",
      "period": "example",
      "unit": "example",
      "taxonomy": "xx",
      "sort": "desc",
      "limit": 1
    }
  }
}

Response

Field	Type	Description
`ok`	boolean	one of: true
`items`	array
`total`	integer	Total matching rows upstream; null when unknown.
`source`	object

Example response datajson

{
  "ok": true,
  "items": [
    {
      "cik": 1,
      "entityName": "example",
      "location": "example",
      "start": "example",
      "end": "example",
      "value": 1,
      "accession": "example"
    }
  ],
  "total": 1,
  "source": {
    "provider": "example",
    "url": "example",
    "license": "example"
  }
}

Discovery

/api/directory — full catalog of every endpoint
/openapi.json — OpenAPI 3.1 spec (per-op x-payment-info, x402Payment security)
/.well-known/x402 — machine-readable service descriptor for x402-aware crawlers
/.well-known/mcp/server-card.json — MCP SEP-1649 server card
/llms.txt — plain-text manifest for LLM ingestion

2s.io is x402-native. Every call is paid per-request from a USDC-funded EVM wallet on Base — no signup, no API keys, no monthly fees. Source code: github.com/2s-io/sdk.