代码 SDK

类型脚本 SDK 代码 API ——实时区块链数据,信使价格,OHLCV图表,钱包余额,以及持有者对包括埃特鲁姆,索拉纳,基地,Arbitrum,BNB,和多边形在内的80+网络的60M+信使的解析.

Codex是Coinbase,TradingView,Uniswap,Rainbow,FOMO,Farcaster等数以百计的团队使用的GraphQL API.

• 文档
• 获取 API 密钥
• 图QL 浏览器

安装

npm install @codex-data/sdk

yarn add @codex-data/sdk

pnpm add @codex-data/sdk

快速启动

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const networks = await sdk.queries.getNetworks({});
console.log(networks.getNetworks); // [{ id: 1, name: "ethereum" }, { id: 1399811149, name: "solana" }, ...]

提示 : 内置 sdk.queries.* 请求方法 每个 可用字段。 他们很擅长探索API,但是我们推荐制作 写入自定义查询 只选择您需要的字段.

获取托肯价格

获得任何代币的当前美元价格。 每个请求最多支持25个令牌. 在所有有效集合中,价格都按流动性加权.

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const prices = await sdk.queries.getTokenPrices({
  inputs: [
    {
      address: "So11111111111111111111111111111111111111112",
      networkId: 1399811149,
    }, // SOL
    { address: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", networkId: 1 }, // WETH
  ],
});

prices.getTokenPrices?.forEach((price) => {
  console.log(`${price?.address}: $${price?.priceUsd}`);
});

为了获得历史代价,通过一个 timestamp数字 :

const historicalPrice = await sdk.queries.getTokenPrices({
  inputs: [
    {
      address: "So11111111111111111111111111111111111111112",
      networkId: 1399811149,
      timestamp: 1704067200, // Unix timestamp
    },
  ],
});

获取 OHLCV 图表数据

获取烛台数据 用于任何标志或交易对等。 支持从1秒到7天的决议.

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const bars = await sdk.queries.getBars({
  symbol: "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1", // WETH on Ethereum
  from: 1704067200,
  to: 1704153600,
  resolution: "60", // 1-hour candles
  removeEmptyBars: true,
});

bars.getBars?.o?.forEach((open, i) => {
  console.log({
    open,
    high: bars.getBars?.h?.[i],
    low: bars.getBars?.l?.[i],
    close: bars.getBars?.c?.[i],
    volume: bars.getBars?.volume?.[i],
    timestamp: bars.getBars?.t?.[i],
  });
});

现有决议: 1S, (中文(简体) ), 5S, (中文(简体) ), 15S, (中文(简体) ), 30S, (中文(简体) ), 1, (中文(简体) ), 5, (中文(简体) ), 15, (中文(简体) ), 30, (中文(简体) ), 60, (中文(简体) ), 240, (中文(简体) ), 720, (中文(简体) ), 1D, (中文(简体) ), 7D

发现和过滤键

按价格,量,市场上限,流动性,持有者计数,交易活动等进行搜索和过滤的代币.

import {
  Codex,
  TokenRankingAttribute,
  RankingDirection,
} from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const result = await sdk.queries.filterTokens({
  filters: {
    network: [1], // Ethereum
    liquidity: { gte: "100000" }, // $100k+ liquidity
    marketCap: { gte: "1000000" }, // $1M+ market cap
    txnCount24: { gte: "500" }, // 500+ transactions in 24h
  },
  rankings: [
    {
      attribute: TokenRankingAttribute.TrendingScore24,
      direction: RankingDirection.Desc,
    },
  ],
  limit: 20,
});

result.filterTokens?.results?.forEach((token) => {
  console.log(
    `${token?.token?.name} (${token?.token?.symbol}): $${token?.priceUSD}`,
  );
});

获取钱包余额

获取带有美元值的钱包地址的所有符号余额 .

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const balances = await sdk.queries.balances({
  input: {
    walletAddress: "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045", // vitalik.eth
    networks: [1],
    includeNative: true,
    removeScams: true,
    limit: 50,
  },
});

balances.balances?.items?.forEach((item) => {
  console.log(
    `${item?.token?.symbol}: ${item?.shiftedBalance} ($${item?.balanceUsd})`,
  );
});

获取托肯控件

获取持有特定符号的钱包列表, 按余额排序 .

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const holders = await sdk.queries.holders({
  input: {
    tokenId: "So11111111111111111111111111111111111111112:1399811149", // SOL
    limit: 50,
  },
});

console.log(`Total holders: ${holders.holders?.count}`);
console.log(`Top 10 hold: ${holders.holders?.top10HoldersPercent}%`);

holders.holders?.items?.forEach((holder) => {
  console.log(
    `${holder?.address}: ${holder?.shiftedBalance} ($${holder?.balanceUsd})`,
  );
});

获取托肯贸易历史

买入 卖出 薄荷 烧掉任何物品.

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const events = await sdk.queries.getTokenEvents({
  query: {
    address: "So11111111111111111111111111111111111111112",
    networkId: 1399811149,
    eventDisplayType: ["Buy", "Sell"],
  },
  limit: 25,
});

events.getTokenEvents?.items?.forEach((event) => {
  console.log(
    `${event?.eventDisplayType} by ${event?.maker} — $${event?.token0SwapValueUsd}`,
  );
});

流出实时价格

说明: WebSocket 订阅需要一个 付费计划。 。 。 .

通过WebSocket订阅直播价格更新. 每一次连锁互换都会起火.

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const unsubscribe = sdk.subscriptions.onPriceUpdated(
  {
    address: "So11111111111111111111111111111111111111112",
    networkId: 1399811149,
  },
  {
    next: (result) => {
      console.log("Price:", result.data?.onPriceUpdated?.priceUsd);
    },
    error: (err) => console.error(err),
    complete: () => console.log("Stream ended"),
  },
);

// Call unsubscribe() to clean up

流出实时 OHLCV 栏

说明: WebSocket 订阅需要一个 付费计划。 。 。 .

在所有决议同时获得烛台实时更新.

import { Codex, QuoteToken } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const unsubscribe = sdk.subscriptions.onBarsUpdated(
  {
    pairId: "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1", // USDC/WETH on Ethereum
    quoteToken: QuoteToken.Token1,
  },
  {
    next: (result) => {
      const bar = result.data?.onBarsUpdated;
      const oneMin = bar?.aggregates?.r1?.usd;
      console.log(
        `1min candle — O: ${oneMin?.o} H: ${oneMin?.h} L: ${oneMin?.l} C: ${oneMin?.c}`,
      );
    },
    error: (err) => console.error(err),
    complete: () => console.log("Stream ended"),
  },
);

流活贸易

说明: WebSocket 订阅需要一个 付费计划。 。 。 .

观看任何交易对面发生的买卖事件.

import { Codex, QuoteToken } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const unsubscribe = sdk.subscriptions.onEventsCreated(
  {
    id: "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1",
    quoteToken: QuoteToken.Token0,
  },
  {
    next: (result) => {
      result.data?.onEventsCreated?.events?.forEach((event) => {
        console.log(
          `${event?.eventDisplayType} by ${event?.maker} — $${event?.token0SwapValueUsd}`,
        );
      });
    },
    error: (err) => console.error(err),
    complete: () => console.log("Stream ended"),
  },
);

边际订阅

过 { useEdge: true } 作为生成的订阅方法的第三个参数(或 sdk.subscribe)使用区域边缘节点。 索拉纳(签名)1399811149至 wss://fra.edge.codex.io/graphql;罗宾链(4663) 和BNB(英语:56路径到 wss://iad.edge.codex.io/graphql 内 us-east-1。每个端点按需创建连接并重新使用.

import { Codex, EventCommitmentLevel } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const unsubscribe = sdk.subscriptions.onTokenEventsCreated(
  {
    input: { tokenAddress: "0x...", networkId: 56 },
    commitmentLevel: [EventCommitmentLevel.Processed],
  },
  {
    next: (result) => console.log(result.data),
    error: (err) => console.error(err),
    complete: () => console.log("Stream ended"),
  },
  { useEdge: true },
);

边缘支持 onEventsCreated, (中文(简体) ), onTokenEventsCreated, (中文(简体) ), onBarsUpdated,以及 onTokenBarsUpdated承诺水平必须包括: Processed,以及 onBarsUpdated 需要明确 quoteToken。每个订阅必须针对一个支持的链条。 无订阅 useEdge 使用主端点.

轻而易举 withEdge 助手从 @codex-data/sdk/edge 使用相同的路由. 对于一个独立的罗宾汉或BNB连接,通过 url: ROBINHOOD_EDGE_URL 或者说 url: BNB_EDGE_URL 改为 createEdgeClient从 @codex-data/sdk/edge. SDK's 。 apiEdgeUrl 和助手的 edgeUrl 覆盖所有链的路由 .

自定义查询: 只请求您需要的字段

内置 sdk.queries.* 方法选择每个可用的字段,所以上面的食谱是最昂贵的调用每个端点的方法. 写自己的查询意味着你得到更小,更快的答复.

有两种方法:

备选案文1: sdk.send() - 快速,零设置

自行写入查询并描述结果类型 :

import { Codex } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const result = await sdk.send<{
  getNetworks: Array<{ id: number; name: string }>;
}>(
  `query GetNetworks {
    getNetworks { id name }
  }`,
  {},
);

console.log("Networks:", result.getNetworks);

与其手写类型,不如重新使用 SDK 的导出查询类型 DeepPartial,使每个字段都可以选择:

import { Codex, DeepPartial, FilterTokensQuery } from "@codex-data/sdk";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const result = await sdk.send<DeepPartial<FilterTokensQuery>>(
  `query FilterTokens($limit: Int) {
    filterTokens(limit: $limit) {
      results {
        priceUSD
        volume24
        token { name symbol }
      }
    }
  }`,
  { limit: 10 },
);

备选案文2:图表QL 代码生成器——准确类型和自动完成

对于生产代码库,我们建议从你自己的查询中生成类型. SDK号在 @codex-data/sdk/schema.graphql,所以代码源运行离线 与你安装的精确计划版本.

安装编码工具 :

npm install -D @graphql-codegen/cli @graphql-codegen/client-preset

添加一个 codegen.ts 转到您的工程根 :

import type { CodegenConfig } from "@graphql-codegen/cli";

const config: CodegenConfig = {
  schema: "./node_modules/@codex-data/sdk/schema.graphql",
  documents: "src/**/*.ts",
  generates: {
    "src/gql/": {
      preset: "client",
      presetConfig: { fragmentMasking: false },
    },
  },
};

export default config;

运行 graphql-codegen,然后用生成的查询写入 graphql() 帮手,把他们交给 sdk.query()。结果类型是从您选择的字段中推断出来的 :

import { Codex } from "@codex-data/sdk";
import { graphql } from "./gql";

const sdk = new Codex(process.env.CODEX_API_KEY!);

const trendingTokens = graphql(`
  query TrendingTokens($limit: Int) {
    filterTokens(limit: $limit) {
      results {
        priceUSD
        volume24
        token {
          name
          symbol
        }
      }
    }
  }
`);

const result = await sdk.query(trendingTokens, { limit: 10 });
// result.filterTokens.results[0].priceUSD — fully typed, only what you asked for

见 代码示例 用于一个完整的工作项目.

通用网络标识

使用 sdk.queries.getNetworks({}) 为80+支持的网络的完整列表.

ID 格式公约

Codex API 中的ID 遵循模式 address:networkId数字 :

• 脚本标识 : 0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2:1 (WETH on Ethereum) (在伊特鲁姆)
• 标对 : 0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640:1 (美国航天中心/Ethereum上的WETH)
• 钱包标识 : 0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045:1

所有可用方法

查询( E)sdk.queries.*(中文(简体) )

订阅sdk.subscriptions.*(b) —— 付费计划 所需经费

变化(sdk.mutations.*(中文(简体) )

配置

import { Codex } from "@codex-data/sdk";

const sdk = new Codex("YOUR_API_KEY", {
  apiUrl: "https://graph.codex.io/graphql", // default
  apiRealtimeUrl: "wss://graph.codex.io/graphql", // default
  ws: true, // enable WebSocket (default: true)
});

// Update config at runtime
sdk.updateConfig({ ws: false });

// Clean up WebSocket connection
sdk.dispose();

实例

见 实例 完整工作项目的目录 :

• 简单 基本查询、过滤和订阅
• 代码 —— 使用 GraphQL 代码生成器进行完全输入自定义查询
• 下一个.js ——全网应用

捐款

我们欢迎捐款! 请随意提交拉力请求.

pnpm install    # Install dependencies
pnpm run build  # Build the SDK
pnpm run test   # Run tests
pnpm run lint   # Lint the codebase

释放

在树枝上,做你的改变,然后:

• pnpm run build
• 变动 package.json 相应版本
• 合并到主机
• 创建 github 发布,其标签与版本相同 package.json

升级到 v2

见 更新(md) 用于从v1到v2的迁移指令.

链接

• Codex API 文档
• 大众端点
• 图QL 浏览器
• 获取 API 密钥
• 代码 MCP 服务器
• 解析器
• 微博

许可证

麻省理工学院