Fundamental stock screener built on SEC EDGAR XBRL Frames — screen every public filer on a reported financial concept for one period, in a single call. Absolute mode: give a concept (e.g. Revenues, NetIncomeLoss, Assets), a period (CY2023 annual, CY2024Q1 quarter, CY2024Q1I instant), and an optional op/value to filter (e.g. Revenues gte 10000000000 → companies with >= $10B FY2023 revenue). Ratio mode: add ratioConcept to compute concept / ratioConcept per company joined by CIK, then op/value filter the ratio (e.g. concept=GrossProfit, ratioConcept=Revenues, op=gte, value=0.7 → gross margin >= 70%). Returns matching companies with CIK, entity name, value (and ratio), sorted, plus meta with the total matched and the screenable universe size. Free, public-domain (SEC EDGAR).
/api/stocks/screenerPAYMENT-SIGNATURE.The screener API is a pay-per-call stocks endpoint built for AI agents and autonomous software. Fundamental stock screener built on SEC EDGAR XBRL Frames — screen every public filer on a reported financial concept for one period, in a single call.
There is no signup and no API key. An agent (or any HTTP client) hits the endpoint, receives an x402 "402 Payment Required" challenge, signs a sub-cent USDC payment on Base or Solana, and retries — the data comes back on the paid request. That makes it a drop-in screener data source for an agent tool-use loop, an MCP host, or a backend that needs stocks data on demand without onboarding to yet another vendor portal.
| Name | Type | Description |
|---|---|---|
conceptrequired | string | XBRL us-gaap concept, e.g. Revenues, GrossProfit, NetIncomeLoss, Assets. min 2 chars · max 80 chars · match ^[A-Za-z0-9]+$ |
periodrequired | string | CY2023 (annual), CY2024Q1 (quarter), CY2024Q1I (instant, for balance-sheet items). match ^CY\d{4}(Q[1-4]I?)?$ |
unit | string | Unit (default USD). min 1 chars · max 20 chars |
op | string | Comparison operator (with value). Filters the concept value, or the ratio when ratioConcept is set. one of: gt | gte | lt | lte |
value | number | Comparison threshold (with op). For ratios use a fraction, e.g. 0.7 for 70%. |
ratioConcept | string | Optional second XBRL concept; computes ratio = concept / ratioConcept per company (joined by CIK), and op/value then filter the ratio. min 2 chars · max 80 chars · match ^[A-Za-z0-9]+$ |
sort | string | Sort by value/ratio (default desc). one of: asc | desc |
limit | integer | Max companies (1-100, default 25). min 1 · max 100 |
# 1. Probe with no auth → 402 envelope with PaymentRequirements curl -sS 'https://2s.io/api/stocks/screener?concept=xx&period=example&unit=example&op=gt&value=1&ratioConcept=xx&sort=asc&limit=1' # 2. Sign + retry with PAYMENT-SIGNATURE: curl -sS 'https://2s.io/api/stocks/screener?concept=xx&period=example&unit=example&op=gt&value=1&ratioConcept=xx&sort=asc&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/stocks/screener?concept=xx&period=example&unit=example&op=gt&value=1&ratioConcept=xx&sort=asc&limit=1'
import { TwoS } from '@2sio/sdk'
const client = new TwoS({
privateKey: process.env.EVM_PRIVATE_KEY as `0x${string}`,
})
const result = await client.stocks.screener({
"concept": "xx",
"period": "example",
"unit": "example",
"op": "gt",
"value": 1,
"ratioConcept": "xx",
"sort": "asc",
"limit": 1
})
console.log('endpoint:', result.endpoint)
console.log('cost:', result.costUsd, 'USDC')
console.log('tx:', result.settlement?.txHash)
console.log('data:', result.data)import os
from twosio import TwoS
client = TwoS(private_key=os.environ["EVM_PRIVATE_KEY"])
result = client.stocks.screener(concept="xx", period="example", unit="example", op="gt", value=1, ratioConcept="xx", sort="asc", limit=1)
print("endpoint:", result.endpoint)
print("cost:", result.cost_usd, "USDC")
print("tx:", (result.settlement or {}).get("tx_hash"))
print("data:", result.data)// 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": "stocks.screener",
"arguments": {
"concept": "xx",
"period": "example",
"unit": "example",
"op": "gt",
"value": 1,
"ratioConcept": "xx",
"sort": "asc",
"limit": 1
}
}
}| Field | Type | Description |
|---|---|---|
ok | boolean | one of: true |
items | array | |
total | integer | Total matching rows upstream; null when unknown. |
source | object |
{
"ok": true,
"items": [
{
"cik": 1,
"entityName": "example",
"value": 1,
"ratio": 1
}
],
"total": 1,
"source": {
"provider": "example",
"url": "example",
"license": "example"
}
}