@surf-ai/sdk 0.1.5-beta → 0.1.6-beta
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +223 -0
- package/dist/db/index.cjs +1 -1
- package/dist/db/index.d.cts +3 -0
- package/dist/db/index.d.ts +3 -0
- package/dist/db/index.js +1 -1
- package/dist/react/index.d.ts +284 -84
- package/dist/react/index.js +148 -65
- package/dist/server/index.cjs +113 -89
- package/dist/server/index.d.cts +195 -1
- package/dist/server/index.d.ts +195 -1
- package/dist/server/index.js +111 -89
- package/package.json +1 -1
package/dist/server/index.cjs
CHANGED
|
@@ -191,18 +191,14 @@ function setupProxy(app, port) {
|
|
|
191
191
|
app.use((0, import_http_proxy_middleware.createProxyMiddleware)({
|
|
192
192
|
target,
|
|
193
193
|
changeOrigin: true,
|
|
194
|
-
selfHandleResponse: true,
|
|
195
194
|
pathFilter: "/proxy",
|
|
196
195
|
on: {
|
|
197
196
|
proxyReq: (proxyReq, req) => {
|
|
198
197
|
console.log(`[proxy] >> ${req.method} ${req.originalUrl}`);
|
|
199
198
|
},
|
|
200
|
-
proxyRes: (
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
console.log(`[proxy] << ${status} ${tag} ${req.method} ${req.originalUrl} bytes=${buf.length}`);
|
|
204
|
-
return buf;
|
|
205
|
-
}),
|
|
199
|
+
proxyRes: (proxyRes, req) => {
|
|
200
|
+
console.log(`[proxy] << ${proxyRes.statusCode} ${req.method} ${req.originalUrl}`);
|
|
201
|
+
},
|
|
206
202
|
error: (err, req, res) => {
|
|
207
203
|
console.error(`[proxy] !! ${req.method} ${req.originalUrl} error: ${err.message}`);
|
|
208
204
|
if (!res.headersSent) res.status(502).json({ error: err.message });
|
|
@@ -537,236 +533,262 @@ init_client();
|
|
|
537
533
|
// src/data/categories/exchange.ts
|
|
538
534
|
init_client();
|
|
539
535
|
var exchange = {
|
|
540
|
-
/**
|
|
536
|
+
/** Returns order book bid/ask levels with computed stats. **Included fields:** spread, spread percentage, mid-price, and total bid/ask depth. Use `limit` to control the number of price levels (1–100, default 20). Set `type=swap` to query perpetual contract order books instead of spot. */
|
|
541
537
|
depth: (params) => get("exchange/depth", params),
|
|
542
|
-
/**
|
|
538
|
+
/** Returns historical funding rate records for a perpetual contract. **Pagination:** use `from` to set the start time and `limit` to control result count. For longer history, pass the last returned timestamp as the next `from` value. **Note:** not all exchanges support historical queries via `from`; some only return recent data regardless. For the latest funding rate snapshot, see `/exchange/perp?fields=funding`. */
|
|
543
539
|
funding_history: (params) => get("exchange/funding-history", params),
|
|
544
|
-
/**
|
|
540
|
+
/** Returns OHLCV candlestick data with period summary stats (high, low, total volume). **Intervals:** 15 options from `1m` to `1M`. **Pagination:** use `from` to set the start time and `limit` to control candle count. For longer ranges, pass the last returned candle's timestamp as the next `from` value. Exchange-side limits vary (200–1000 per request). Set `type=swap` to query perpetual contract candles instead of spot. */
|
|
545
541
|
klines: (params) => get("exchange/klines", params),
|
|
546
|
-
/**
|
|
542
|
+
/** Returns historical long/short ratio for a perpetual contract. **Included fields:** ratio value, long account percentage, short account percentage. **Granularity:** `interval` supports `1h`, `4h`, `1d`. **Pagination:** use `from` for start time and `limit` for result count. For longer history, pass the last returned timestamp as the next `from` value. **Note:** not all exchanges support historical queries via `from`; some only return recent data regardless. Just pass the base pair (e.g. `pair=BTC/USDT`). For aggregated cross-exchange long/short ratio, see `/market/futures`. */
|
|
547
543
|
long_short_ratio: (params) => get("exchange/long-short-ratio", params),
|
|
548
|
-
/**
|
|
544
|
+
/** Returns trading pairs available on an exchange. **Filters:** `type` (`spot`, `swap`, `future`, `option`) or free-text `search`. **Included fields:** pair name, base/quote currencies, market type, active status, and default fee rates. Use the returned `pair` values as the `pair` parameter in other exchange endpoints. */
|
|
549
545
|
markets: (params) => get("exchange/markets", params),
|
|
550
|
-
/**
|
|
546
|
+
/** Returns a combined snapshot of perpetual contract data for a pair. **Available fields** (via `fields`): - `funding` — current funding rate, next settlement, mark/index price - `oi` — open interest in contracts and USD Just pass the base pair (e.g. `pair=BTC/USDT`). The `:USDT` swap suffix is added automatically. */
|
|
551
547
|
perp: (params) => get("exchange/perp", params),
|
|
552
|
-
/**
|
|
548
|
+
/** Returns the real-time ticker for a trading pair. **Included fields:** last price, bid/ask, 24h high/low, 24h volume, 24h price change. Set `type=swap` to query perpetual contract prices instead of spot. For historical price trends, use `/market/price`. */
|
|
553
549
|
price: (params) => get("exchange/price", params)
|
|
554
550
|
};
|
|
555
551
|
|
|
556
552
|
// src/data/categories/fund.ts
|
|
557
553
|
init_client();
|
|
558
554
|
var fund = {
|
|
559
|
-
/**
|
|
555
|
+
/** Returns a fund's **profile metadata**. **Included fields:** X accounts, team members, recent research, invested project count. This does NOT return the list of investments — use `/fund/portfolio` for that. **Lookup:** by UUID (`id`) or name (`q`). Returns 404 if not found. */
|
|
560
556
|
detail: (params) => get("fund/detail", params),
|
|
561
|
-
/**
|
|
557
|
+
/** Returns investment rounds for a fund's portfolio, sorted by date (newest first). A project may appear multiple times if the fund participated in multiple rounds. **Included fields:** project name, logo, date, raise amount, lead investor status. **Lookup:** by UUID (`id`) or name (`q`). */
|
|
562
558
|
portfolio: (params) => get("fund/portfolio", params),
|
|
563
|
-
/**
|
|
559
|
+
/** Returns top-ranked funds by a specified metric. **Available metrics:** `tier` (lower is better), `portfolio_count` (number of invested projects). */
|
|
564
560
|
ranking: (params) => get("fund/ranking", params)
|
|
565
561
|
};
|
|
566
562
|
|
|
567
563
|
// src/data/categories/kalshi.ts
|
|
568
564
|
init_client();
|
|
569
565
|
var kalshi = {
|
|
570
|
-
/**
|
|
566
|
+
/** Returns Kalshi events with nested markets, optionally filtered by `event_ticker`. Each event includes market count and a list of markets. **Data refresh:** ~30 minutes */
|
|
571
567
|
events: (params) => get("prediction-market/kalshi/events", params),
|
|
572
|
-
/**
|
|
568
|
+
/** Returns Kalshi markets, optionally filtered by `market_ticker`. Each market includes price, volume, and status. **Data refresh:** ~30 minutes */
|
|
573
569
|
markets: (params) => get("prediction-market/kalshi/markets", params),
|
|
574
|
-
/**
|
|
570
|
+
/** Returns daily open interest history for a Kalshi market, filtered by `time_range`. **Data refresh:** ~30 minutes */
|
|
575
571
|
open_interest: (params) => get("prediction-market/kalshi/open-interest", params),
|
|
576
|
-
/**
|
|
572
|
+
/** Returns price history for a Kalshi market. **Interval options:** - `interval=1d` — daily OHLC from market reports (~30 min delay) - `interval=latest` — real-time price from trades **Data refresh:** ~30 minutes (daily), real-time (latest) */
|
|
577
573
|
prices: (params) => get("prediction-market/kalshi/prices", params),
|
|
578
|
-
/**
|
|
574
|
+
/** Returns top-ranked Kalshi markets by last day's `notional_volume_usd` or `open_interest`. **Filters:** `status`. **Data refresh:** ~30 minutes */
|
|
579
575
|
ranking: (params) => get("prediction-market/kalshi/ranking", params),
|
|
580
|
-
/**
|
|
576
|
+
/** Returns individual trade records for a Kalshi market. **Filters:** `taker_side`, `min_contracts`, and date range. **Sort:** `timestamp` or `num_contracts`. **Data refresh:** real-time */
|
|
581
577
|
trades: (params) => get("prediction-market/kalshi/trades", params),
|
|
582
|
-
/**
|
|
578
|
+
/** Returns daily trading volume history for a Kalshi market, filtered by `time_range`. **Data refresh:** ~30 minutes */
|
|
583
579
|
volumes: (params) => get("prediction-market/kalshi/volumes", params)
|
|
584
580
|
};
|
|
585
581
|
|
|
586
582
|
// src/data/categories/market.ts
|
|
587
583
|
init_client();
|
|
588
584
|
var market = {
|
|
589
|
-
/**
|
|
585
|
+
/** Returns daily ETF flow history for US spot ETFs. **Included fields:** net flow (USD), token price, per-ticker breakdown. Sorted by date descending. `symbol`: `BTC` or `ETH`. */
|
|
590
586
|
etf: (params) => get("market/etf", params),
|
|
591
|
-
/**
|
|
587
|
+
/** Returns Bitcoin Fear & Greed Index history. **Included fields:** index value (0-100), classification label, BTC price at each data point. Sorted newest-first. Use `from`/`to` to filter by date range. */
|
|
592
588
|
fear_greed: (params) => get("market/fear-greed", params),
|
|
593
|
-
/**
|
|
589
|
+
/** Returns futures market data across all tracked tokens. **Included fields:** open interest, funding rate, long/short ratio, 24h volume. Sorted by `volume_24h` by default — use `sort_by` to change. */
|
|
594
590
|
futures: (params) => get("market/futures", params),
|
|
595
|
-
/**
|
|
591
|
+
/** Returns OHLC-style aggregated liquidation data for a token on a specific exchange. **Filters:** `symbol`, `exchange`, `interval`. Useful for charting liquidation volume over time. */
|
|
596
592
|
liquidation_chart: (params) => get("market/liquidation/chart", params),
|
|
597
|
-
/**
|
|
593
|
+
/** Returns liquidation breakdown by exchange. **Included fields:** total, long, and short volumes in USD. **Filters:** `symbol` and `time_range` (`1h`, `4h`, `12h`, `24h`). */
|
|
598
594
|
liquidation_exchange_list: (params) => get("market/liquidation/exchange-list", params),
|
|
599
|
-
/**
|
|
595
|
+
/** Returns individual large liquidation orders above a USD threshold (`min_amount`, default 10000). **Filters:** `exchange` and `symbol`. For aggregate totals and long/short breakdown by exchange, use `/market/liquidation/exchange-list`. For historical liquidation charts, use `/market/liquidation/chart`. */
|
|
600
596
|
liquidation_order: (params) => get("market/liquidation/order", params),
|
|
601
|
-
/**
|
|
597
|
+
/** Returns on-chain indicator time-series for BTC or ETH. **Available metrics:** `nupl`, `sopr`, `mvrv`, `puell-multiple`, `nvm`, `nvt`, `nvt-golden-cross`, `exchange-flows` (inflow/outflow/netflow/reserve). */
|
|
602
598
|
onchain_indicator: (params) => get("market/onchain-indicator", params),
|
|
603
|
-
/**
|
|
599
|
+
/** Returns options market data for a `symbol`. **Included fields:** open interest, volume, put/call ratio, max pain price. */
|
|
604
600
|
options: (params) => get("market/options", params),
|
|
605
|
-
/**
|
|
601
|
+
/** Returns historical price data points for a token over a specified time range. **Time range options:** - Predefined: `1d`, `7d`, `14d`, `30d`, `90d`, `180d`, `365d`, `max` - Custom: use `from` / `to` (Unix seconds or `YYYY-MM-DD`) **Granularity** is automatic based on range: - `1d` → 5-minute intervals - `7d`–`90d` → hourly - `180d`+ → daily */
|
|
606
602
|
price: (params) => get("market/price", params),
|
|
607
|
-
/**
|
|
603
|
+
/** Returns a technical indicator for a trading pair on a given exchange and interval. **Modes:** - Set `from`/`to` for time-series - Omit for latest value only **Indicator-specific tuning** via `options` (e.g. `period:7`, `fast_period:8,slow_period:21,signal_period:5`, `period:10,stddev:1.5`). **Available indicators:** `rsi`, `macd`, `ema`, `sma`, `bbands`, `stoch`, `adx`, `atr`, `cci`, `obv`, `vwap`, `dmi`, `ichimoku`, `supertrend`. */
|
|
608
604
|
price_indicator: (params) => get("market/price-indicator", params),
|
|
609
|
-
/**
|
|
605
|
+
/** Returns tokens ranked by a specified metric. **Available metrics:** `market_cap`, `top_gainers`, `top_losers`, `volume`. **Note:** `top_gainers` and `top_losers` rank by 24h price change within the top 250 coins by market cap. For circulating supply, FDV, ATH/ATL, use `/project/detail?fields=token_info`. */
|
|
610
606
|
ranking: (params) => get("market/ranking", params)
|
|
611
607
|
};
|
|
612
608
|
|
|
609
|
+
// src/data/categories/matching.ts
|
|
610
|
+
init_client();
|
|
611
|
+
var matching = {
|
|
612
|
+
/** Returns daily volume and open interest comparison for a specific matched market pair. Both `polymarket_condition_id` and `kalshi_market_ticker` are required. **Volume units:** Polymarket = USD, Kalshi = contracts. */
|
|
613
|
+
market_daily: (params) => get("prediction-market/matching/daily", params),
|
|
614
|
+
/** Given a Polymarket condition_id or Kalshi market_ticker, find the corresponding match on the other platform. Provide at least one of `polymarket_condition_id` or `kalshi_market_ticker`. When both are provided, results are filtered to pairs matching both (useful for verifying a specific pair). */
|
|
615
|
+
market_find: (params) => get("prediction-market/matching/find", params),
|
|
616
|
+
/** Returns one-to-one matched market pairs between Polymarket and Kalshi. Each pair maps a Polymarket condition_id to a Kalshi market_ticker with a confidence score. **Volume units differ:** Polymarket = USD, Kalshi = contracts ($1 binary options). **Data refresh:** seed-driven, updated periodically. */
|
|
617
|
+
market_pairs: (params) => get("prediction-market/matching/pairs", params)
|
|
618
|
+
};
|
|
619
|
+
|
|
613
620
|
// src/data/categories/news.ts
|
|
614
621
|
init_client();
|
|
615
622
|
var news = {
|
|
616
623
|
/** Returns the full content of a single news article by its ID (returned as `id` in feed and search results). */
|
|
617
624
|
detail: (params) => get("news/detail", params),
|
|
618
|
-
/**
|
|
625
|
+
/** Returns crypto news from major sources. **Filters:** `source` (enum), `project`, and time range (`from`/`to`). **Sort:** `recency` (default) or `trending`. Use the detail endpoint with article `id` for full content. */
|
|
619
626
|
feed: (params) => get("news/feed", params)
|
|
620
627
|
};
|
|
621
628
|
|
|
622
629
|
// src/data/categories/onchain.ts
|
|
623
630
|
init_client();
|
|
624
631
|
var onchain = {
|
|
625
|
-
/**
|
|
632
|
+
/** Returns bridge protocols ranked by total USD volume over a specified time range. */
|
|
626
633
|
bridge_ranking: (params) => get("onchain/bridge/ranking", params),
|
|
627
|
-
/**
|
|
634
|
+
/** Returns the current gas price for an EVM chain via `eth_gasPrice` JSON-RPC. **Included fields:** gas price in both wei (raw) and Gwei (human-readable). **Supported chains:** `ethereum`, `polygon`, `bsc`, `arbitrum`, `optimism`, `base`, `avalanche`, `fantom`, `linea`, `cyber`. */
|
|
628
635
|
gas_price: (params) => get("onchain/gas-price", params),
|
|
629
|
-
/**
|
|
636
|
+
/** Executes a structured JSON query on blockchain data. No raw SQL needed — specify source, fields, filters, sort, and pagination. All tables live in the **agent** database. Use `GET /v1/onchain/schema` to discover available tables and their columns. **Key rules:** - **Source format:** `agent.<table_name>` (e.g. `agent.ethereum_transactions`, `agent.ethereum_dex_trades`) - Max 10,000 rows (default 20), 30s timeout - **Always filter on block_date** — it is the partition key. Without it, queries scan billions of rows and will timeout **Data refresh:** ~24 hours. ## Example ```json { "source": "agent.ethereum_dex_trades", "fields": ["block_time", "project", "token_pair", "amount_usd", "taker"], "filters": [ {"field": "block_date", "op": "gte", "value": "2025-03-01"}, {"field": "project", "op": "eq", "value": "uniswap"}, {"field": "amount_usd", "op": "gte", "value": 100000} ], "sort": [{"field": "amount_usd", "order": "desc"}], "limit": 20 } ``` */
|
|
630
637
|
structured_query: (body) => post("onchain/query", body),
|
|
631
|
-
/**
|
|
638
|
+
/** Returns table metadata for all available on-chain databases. **Included fields:** database name, table name, column names, types, and comments. */
|
|
632
639
|
schema: () => get("onchain/schema"),
|
|
633
|
-
/**
|
|
640
|
+
/** Executes a raw SQL SELECT query against blockchain data. All tables live in the **agent** database. Use `GET /v1/onchain/schema` to discover available tables and their columns before writing queries. ## Rules - Only SELECT/WITH statements allowed (read-only) - All table references must be database-qualified: `agent.<table_name>` - Max 10,000 rows (default 1,000), 30s timeout - **Always filter on block_date or block_number** — partition key, without it queries will timeout - Avoid `SELECT *` on large tables — specify only the columns you need **Data refresh:** ~24 hours. ## Example ```sql SELECT block_time, token_pair, amount_usd, taker, tx_hash FROM agent.ethereum_dex_trades WHERE block_date >= today() - 7 AND project = 'uniswap' AND amount_usd > 100000 ORDER BY amount_usd DESC LIMIT 20 ``` */
|
|
634
641
|
sql: (body) => post("onchain/sql", body),
|
|
635
|
-
/**
|
|
642
|
+
/** Returns transaction details by hash. All numeric fields are hex-encoded — use parseInt(hex, 16) to convert. **Supported chains:** `ethereum`, `polygon`, `bsc`, `arbitrum`, `optimism`, `base`, `avalanche`, `fantom`, `linea`, `cyber`. Returns 404 if the transaction is not found. */
|
|
636
643
|
tx: (params) => get("onchain/tx", params),
|
|
637
|
-
/**
|
|
644
|
+
/** Returns DeFi yield pools ranked by APY or TVL. Returns the latest snapshot. Filter by protocol. */
|
|
638
645
|
yield_ranking: (params) => get("onchain/yield/ranking", params)
|
|
639
646
|
};
|
|
640
647
|
|
|
641
648
|
// src/data/categories/polymarket.ts
|
|
642
649
|
init_client();
|
|
643
650
|
var polymarket = {
|
|
644
|
-
/**
|
|
651
|
+
/** Returns trade and redemption activity for a Polymarket wallet. **Data refresh:** ~30 minutes */
|
|
645
652
|
activity: (params) => get("prediction-market/polymarket/activity", params),
|
|
646
|
-
/**
|
|
653
|
+
/** Returns Polymarket events with nested markets, optionally filtered by `event_slug`. Each event includes aggregated status, volume, and a list of markets with `side_a`/`side_b` outcomes. **Data refresh:** ~30 minutes */
|
|
647
654
|
events: (params) => get("prediction-market/polymarket/events", params),
|
|
648
|
-
/**
|
|
655
|
+
/** Returns Polymarket markets, optionally filtered by `market_slug`. Each market includes `side_a` and `side_b` outcomes. Current prices are available via `/polymarket/prices` using the `condition_id`. **Data refresh:** ~30 minutes */
|
|
649
656
|
markets: (params) => get("prediction-market/polymarket/markets", params),
|
|
650
|
-
/**
|
|
657
|
+
/** Returns daily open interest history for a Polymarket market. **Data refresh:** ~30 minutes */
|
|
651
658
|
open_interest: (params) => get("prediction-market/polymarket/open-interest", params),
|
|
652
|
-
/**
|
|
659
|
+
/** Returns wallet positions on Polymarket markets. **Data refresh:** ~30 minutes */
|
|
653
660
|
positions: (params) => get("prediction-market/polymarket/positions", params),
|
|
654
|
-
/**
|
|
661
|
+
/** Returns aggregated price history for a Polymarket market. Use `interval=latest` for the most recent price snapshot. **Data refresh:** ~30 minutes */
|
|
655
662
|
prices: (params) => get("prediction-market/polymarket/prices", params),
|
|
656
|
-
/**
|
|
663
|
+
/** Returns top-ranked Polymarket markets. **Sort by:** `volume_24h`, `volume_7d`, `open_interest`, or `trade_count`. **Filters:** `status` and `end_before`. **Data refresh:** ~30 minutes */
|
|
657
664
|
ranking: (params) => get("prediction-market/polymarket/ranking", params),
|
|
658
|
-
/**
|
|
665
|
+
/** Returns paginated trade records for a Polymarket market or wallet. **Filters:** `condition_id` (market) or `address` (wallet), plus `outcome_label`, `min_amount`, and date range. At least one of `condition_id` or `address` is required. **Sort:** `newest`, `oldest`, or `largest`. **Data refresh:** ~30 minutes */
|
|
659
666
|
trades: (params) => get("prediction-market/polymarket/trades", params),
|
|
660
|
-
/**
|
|
667
|
+
/** Returns trading volume and trade count history for a Polymarket market. **Data refresh:** ~30 minutes */
|
|
661
668
|
volumes: (params) => get("prediction-market/polymarket/volumes", params)
|
|
662
669
|
};
|
|
663
670
|
|
|
664
671
|
// src/data/categories/prediction_market.ts
|
|
665
672
|
init_client();
|
|
666
673
|
var prediction_market = {
|
|
667
|
-
/**
|
|
674
|
+
/** Returns daily notional volume and open interest aggregated by category across Kalshi and Polymarket. **Filters:** `source` or `category`. **Data refresh:** daily */
|
|
668
675
|
category_metrics: (params) => get("prediction-market/category-metrics", params)
|
|
669
676
|
};
|
|
670
677
|
|
|
671
678
|
// src/data/categories/project.ts
|
|
672
679
|
init_client();
|
|
673
680
|
var project = {
|
|
674
|
-
/**
|
|
681
|
+
/** Returns time-series DeFi metrics for a project. **Available metrics:** `volume`, `fee`, `fees`, `revenue`, `tvl`, `users`. **Lookup:** by UUID (`id`) or name (`q`). Filter by `chain` and date range (`from`/`to`). Returns 404 if the project is not found. **Note:** this endpoint only returns data for DeFi protocol projects (e.g. `aave`, `uniswap`, `lido`, `makerdao`). Use `q` with a DeFi protocol name. */
|
|
675
682
|
defi_metrics: (params) => get("project/defi/metrics", params),
|
|
676
|
-
/**
|
|
683
|
+
/** Returns top DeFi projects ranked by a protocol metric. **Available metrics:** `tvl`, `revenue`, `fees`, `volume`, `users`. */
|
|
677
684
|
defi_ranking: (params) => get("project/defi/ranking", params),
|
|
678
|
-
/**
|
|
685
|
+
/** Returns multiple project sub-resources in a single request. **Available fields** (via `fields`): `overview`, `token_info`, `tokenomics`, `funding`, `team`, `contracts`, `social`, `tge_status`. **Lookup:** accepts project names directly via `q` (e.g. `?q=aave`) — no need to call `/search/project` first. Also accepts UUID via `id`. Returns 404 if not found. For DeFi metrics (TVL, fees, revenue, volume, users) and per-chain breakdown, use `/project/defi/metrics`. */
|
|
679
686
|
detail: (params) => get("project/detail", params)
|
|
680
687
|
};
|
|
681
688
|
|
|
682
689
|
// src/data/categories/search.ts
|
|
683
690
|
init_client();
|
|
684
691
|
var search = {
|
|
685
|
-
/**
|
|
692
|
+
/** Searches and filters airdrop opportunities. **Filters:** keyword, status, reward type, task type. Returns paginated results with optional task details. */
|
|
686
693
|
airdrop: (params) => get("search/airdrop", params),
|
|
687
|
-
/**
|
|
694
|
+
/** Searches project events by keyword, optionally filtered by `type`. **Valid types:** `launch`, `upgrade`, `partnership`, `news`, `airdrop`, `listing`, `twitter`. **Lookup:** by UUID (`id`) or name (`q`). Returns 404 if the project is not found. */
|
|
688
695
|
events: (params) => get("search/events", params),
|
|
689
|
-
/**
|
|
696
|
+
/** Searches funds by keyword. **Included fields:** name, tier, type, logo, top invested projects. */
|
|
690
697
|
fund: (params) => get("search/fund", params),
|
|
691
|
-
/**
|
|
698
|
+
/** Searches Kalshi events by keyword and/or category. **Filters:** - Keyword matching event title, subtitle, or market title - Category At least one of `q` or `category` is required. Returns events with nested markets. **Data refresh:** ~30 minutes */
|
|
692
699
|
kalshi: (params) => get("search/kalshi", params),
|
|
693
|
-
/**
|
|
700
|
+
/** Searches crypto news articles by keyword. Returns top 10 results ranked by relevance with highlighted matching fragments. */
|
|
694
701
|
news: (params) => get("search/news", params),
|
|
695
|
-
/**
|
|
702
|
+
/** Searches Polymarket events by keyword, tags, and/or category. **Filters:** - Keyword matching market question, event title, or description - Comma-separated tag labels - Surf-curated category At least one of `q`, `tags`, or `category` is required. Returns events with nested markets ranked by volume. **Data refresh:** ~30 minutes */
|
|
696
703
|
polymarket: (params) => get("search/polymarket", params),
|
|
697
|
-
/**
|
|
704
|
+
/** Searches crypto projects by keyword. **Included fields:** name, description, chains, logo. */
|
|
698
705
|
project: (params) => get("search/project", params),
|
|
699
|
-
/**
|
|
706
|
+
/** Searches X (Twitter) users by keyword. **Included fields:** handle, display name, bio, follower count, avatar. */
|
|
700
707
|
social_people: (params) => get("search/social/people", params),
|
|
701
|
-
/**
|
|
708
|
+
/** Searches X (Twitter) posts by keyword or `from:handle` syntax. **Included fields:** author, content, engagement metrics, timestamp. **Pagination:** check `meta.has_more`; if true, pass `meta.next_cursor` as the `cursor` query parameter in the next request. */
|
|
702
709
|
social_posts: (params) => get("search/social/posts", params),
|
|
703
|
-
/**
|
|
710
|
+
/** Searches wallets by ENS name, address label, or address prefix. Returns matching wallet addresses with entity labels. */
|
|
704
711
|
wallet: (params) => get("search/wallet", params),
|
|
705
|
-
/**
|
|
712
|
+
/** Searches web pages, articles, and content by keyword. **Filters:** domain via `site` (e.g. `coindesk.com`). **Included fields:** titles, URLs, content snippets. */
|
|
706
713
|
web: (params) => get("search/web", params)
|
|
707
714
|
};
|
|
708
715
|
|
|
709
716
|
// src/data/categories/social.ts
|
|
710
717
|
init_client();
|
|
711
718
|
var social = {
|
|
712
|
-
/**
|
|
719
|
+
/** Returns a **point-in-time snapshot** of social analytics for a project. **Available fields** (via `fields`): `sentiment`, `follower_geo`, `smart_followers`. **Lookup:** by X account ID (`x_id`) or project name (`q`, e.g. `uniswap`, `solana`). The `q` parameter must be a crypto project name, not a personal Twitter handle. Returns 404 if the project has no linked Twitter account. For sentiment **trends over time**, use `/social/mindshare` instead. */
|
|
713
720
|
detail: (params) => get("social/detail", params),
|
|
714
|
-
/**
|
|
721
|
+
/** Returns mindshare (social view count) **time-series trend** for a project, aggregated by `interval`. **Intervals:** `5m`, `1h`, `1d`, `7d`. **Filters:** date range with `from`/`to` (Unix seconds). Lookup by name (`q`). Use this for sentiment **trends**, mindshare **over time**, or social momentum changes. For a **point-in-time snapshot** of social analytics (sentiment score, follower geo, smart followers), use `/social/detail` instead. */
|
|
715
722
|
mindshare: (params) => get("social/mindshare", params),
|
|
716
|
-
/**
|
|
723
|
+
/** Returns top crypto projects ranked by mindshare (social view count), refreshed every 5 minutes. **Filters:** - `tag` — scope to a category (e.g. `dex`, `l1`, `meme`) - `time_range` — ranking window (`24h`, `48h`, `7d`, `30d`) Supports `limit`/`offset` pagination. */
|
|
717
724
|
ranking: (params) => get("social/ranking", params),
|
|
718
|
-
/**
|
|
725
|
+
/** Returns smart follower count time-series for a project, sorted by date descending. **Lookup:** by X account ID (`x_id`) or project name (`q`). The `q` parameter must be a project name (e.g. `uniswap`, `ethereum`), not a personal X handle — use `x_id` for individual accounts. Returns 404 if the project has no linked X account. */
|
|
719
726
|
smart_followers_history: (params) => get("social/smart-followers/history", params),
|
|
720
|
-
/** Returns replies/comments on a specific tweet. Lookup by `tweet_id`. */
|
|
727
|
+
/** Returns replies/comments on a specific tweet. **Lookup:** by `tweet_id`. */
|
|
721
728
|
tweet_replies: (params) => get("social/tweet/replies", params),
|
|
722
|
-
/**
|
|
729
|
+
/** Returns X (Twitter) posts by numeric post ID strings. Pass up to 100 comma-separated IDs via the `ids` query parameter. */
|
|
723
730
|
tweets: (params) => get("social/tweets", params),
|
|
724
|
-
/**
|
|
731
|
+
/** Returns an X (Twitter) user profile. **Included fields:** display name, follower count, following count, and bio. **Lookup:** by `handle` (without @). */
|
|
725
732
|
user: (params) => get("social/user", params),
|
|
726
|
-
/** Returns a list of followers for the specified handle on X (Twitter). Lookup by `handle` (without @). */
|
|
733
|
+
/** Returns a list of followers for the specified handle on X (Twitter). **Lookup:** by `handle` (without @). */
|
|
727
734
|
user_followers: (params) => get("social/user/followers", params),
|
|
728
|
-
/** Returns a list of users that the specified handle follows on X (Twitter). Lookup by `handle` (without @). */
|
|
735
|
+
/** Returns a list of users that the specified handle follows on X (Twitter). **Lookup:** by `handle` (without @). */
|
|
729
736
|
user_following: (params) => get("social/user/following", params),
|
|
730
|
-
/**
|
|
737
|
+
/** Returns recent X (Twitter) posts by a specific user, ordered by recency. **Lookup:** by `handle` (without @). Use `filter=original` to exclude retweets. **Pagination:** check `meta.has_more`; if true, pass `meta.next_cursor` as the `cursor` query parameter in the next request. */
|
|
731
738
|
user_posts: (params) => get("social/user/posts", params),
|
|
732
|
-
/** Returns recent replies by the specified handle on X (Twitter). Lookup by `handle` (without @). */
|
|
739
|
+
/** Returns recent replies by the specified handle on X (Twitter). **Lookup:** by `handle` (without @). */
|
|
733
740
|
user_replies: (params) => get("social/user/replies", params)
|
|
734
741
|
};
|
|
735
742
|
|
|
736
743
|
// src/data/categories/token.ts
|
|
737
744
|
init_client();
|
|
738
745
|
var token = {
|
|
739
|
-
/**
|
|
746
|
+
/** Returns recent DEX swap events for a token contract address. **Covered DEXes:** `uniswap`, `sushiswap`, `curve`, `balancer`. **Included fields:** trading pair, amounts, USD value, taker address. **Data refresh:** ~24 hours · **Chains:** Ethereum, Base */
|
|
740
747
|
dex_trades: (params) => get("token/dex-trades", params),
|
|
741
|
-
/**
|
|
748
|
+
/** Returns top token holders for a contract address. **Included fields:** wallet address, balance, and percentage. **Lookup:** by `address` and `chain`. Supports EVM chains and Solana. */
|
|
742
749
|
holders: (params) => get("token/holders", params),
|
|
743
|
-
/**
|
|
750
|
+
/** Returns token unlock time-series with amounts and allocation breakdowns. **Lookup:** by project UUID (`id`) or token `symbol`. Filter by date range with `from`/`to` — defaults to the current calendar month when omitted. Returns 404 if no token found. */
|
|
744
751
|
tokenomics: (params) => get("token/tokenomics", params),
|
|
745
|
-
/**
|
|
752
|
+
/** Returns recent transfer events **for a specific token** (ERC-20/TRC-20 contract). Pass the **token contract address** in `address` — returns every on-chain transfer of that token regardless of sender/receiver. **Included fields:** sender, receiver, raw amount, block timestamp. Use this to analyze a token's on-chain activity (e.g. large movements, distribution patterns). **Lookup:** `address` (token contract) + `chain`. Sort by `asc` or `desc`. **Data refresh:** ~24 hours · **Chains:** Ethereum, Base, TRON (Solana uses a different source with no delay) */
|
|
746
753
|
transfers: (params) => get("token/transfers", params)
|
|
747
754
|
};
|
|
748
755
|
|
|
756
|
+
// src/data/categories/v2.ts
|
|
757
|
+
init_client();
|
|
758
|
+
var v2 = {
|
|
759
|
+
/** Historical orderbook snapshots for a Kalshi market. Returns yes-side bid/ask levels. Timestamps in milliseconds, prices in cents. Data refresh: ~5 minutes */
|
|
760
|
+
kalshi_orderbooks: (params) => get("gateway/v2/kalshi/orderbooks", params),
|
|
761
|
+
/** OHLCV candlestick data for a Polymarket market. Prices normalized to YES side. Data refresh: ~30 minutes */
|
|
762
|
+
polymarket_candlesticks: (params) => get("gateway/v2/polymarket/candlesticks/{condition_id}", params),
|
|
763
|
+
/** Cumulative volume time series for a Polymarket token. Data refresh: ~30 minutes */
|
|
764
|
+
polymarket_volume_timeseries: (params) => get("gateway/v2/polymarket/markets/{token_id}/volume", params),
|
|
765
|
+
/** Historical orderbook snapshots for a Polymarket token. Returns raw bid/ask depth levels. Timestamps in milliseconds. Data refresh: ~5 minutes */
|
|
766
|
+
polymarket_orderbooks: (params) => get("gateway/v2/polymarket/orderbooks", params),
|
|
767
|
+
/** Volume breakdown by outcome (YES/NO) for a Polymarket market. Data refresh: ~30 minutes */
|
|
768
|
+
polymarket_volume_chart: (params) => get("gateway/v2/polymarket/volume-chart/{condition_id}", params)
|
|
769
|
+
};
|
|
770
|
+
|
|
749
771
|
// src/data/categories/wallet.ts
|
|
750
772
|
init_client();
|
|
751
773
|
var wallet = {
|
|
752
|
-
/**
|
|
774
|
+
/** Returns multiple wallet sub-resources in a single request. **Available fields** (via `fields`): `balance`, `tokens`, `labels`, `nft`. **Lookup:** by `address`. Partial failures return available fields with per-field error info. Returns 422 if `fields` is invalid. */
|
|
753
775
|
detail: (params) => get("wallet/detail", params),
|
|
754
|
-
/**
|
|
776
|
+
/** Returns full transaction history for a wallet — swaps, transfers, and contract interactions. **Lookup:** by `address`. Filter by `chain` — supports `ethereum`, `polygon`, `bsc`, `arbitrum`, `optimism`, `avalanche`, `fantom`, `base`. */
|
|
755
777
|
history: (params) => get("wallet/history", params),
|
|
756
|
-
/**
|
|
778
|
+
/** Returns entity labels for multiple wallet addresses. Pass up to 100 comma-separated addresses via the `addresses` query parameter. **Included fields:** entity name, type, and labels per address. */
|
|
757
779
|
labels_batch: (params) => get("wallet/labels/batch", params),
|
|
758
|
-
/**
|
|
780
|
+
/** Returns a time-series of the wallet's total net worth in USD. Returns ~288 data points at 5-minute intervals covering the last 24 hours. Fixed window — no custom time range supported. */
|
|
759
781
|
net_worth: (params) => get("wallet/net-worth", params),
|
|
760
|
-
/**
|
|
782
|
+
/** Returns all DeFi protocol positions for a wallet — lending, staking, LP, and farming with token breakdowns and USD values. **Lookup:** by `address`. */
|
|
761
783
|
protocols: (params) => get("wallet/protocols", params),
|
|
762
|
-
/**
|
|
784
|
+
/** Returns recent token transfers **sent or received by a wallet**. Pass the **wallet address** in `address` — returns all ERC-20/SPL token transfers where this wallet is the sender or receiver. **Included fields:** token contract, counterparty, raw amount, block timestamp. Use this to audit a wallet's token flow (e.g. inflows, outflows, airdrop receipts). **Lookup:** `address` (wallet, raw 0x hex or base58 — ENS not supported). Filter by `chain` — supports `ethereum`, `base`, `solana`. **Data refresh:** ~24 hours · **Chains:** Ethereum, Base (Solana uses a different source with no delay) */
|
|
763
785
|
transfers: (params) => get("wallet/transfers", params)
|
|
764
786
|
};
|
|
765
787
|
|
|
766
788
|
// src/data/categories/web.ts
|
|
767
789
|
init_client();
|
|
768
790
|
var web = {
|
|
769
|
-
/**
|
|
791
|
+
/** Fetches a web page and converts it to clean, LLM-friendly markdown. **Options:** - `target_selector` — extract specific page sections - `remove_selector` — strip unwanted elements Returns 400 if the URL is invalid or unreachable. */
|
|
770
792
|
fetch: (params) => get("web/fetch", params)
|
|
771
793
|
};
|
|
772
794
|
|
|
@@ -780,6 +802,7 @@ var dataApi = {
|
|
|
780
802
|
fund,
|
|
781
803
|
kalshi,
|
|
782
804
|
market,
|
|
805
|
+
matching,
|
|
783
806
|
news,
|
|
784
807
|
onchain,
|
|
785
808
|
polymarket,
|
|
@@ -788,6 +811,7 @@ var dataApi = {
|
|
|
788
811
|
search,
|
|
789
812
|
social,
|
|
790
813
|
token,
|
|
814
|
+
v2,
|
|
791
815
|
wallet,
|
|
792
816
|
web
|
|
793
817
|
};
|