# 快速开始

拿一把 Key（可免费试用，$0.10 额度），调一次，读懂返回：大约 2 分钟。之后换 21 个平台里的任何一个，用法都一样。

## 三步

### 1. 拿到 Key

用邮箱收到的 6 位验证码[登录](https://dataxapi.com/zh/signin/)，或者用 Google 登录，不用密码。新账户可免费试用（$0.10 额度），一个邮箱一次，按每次 $0.0020 够调 50 次。

第一把 Key 在注册完成后显示一次，当场复制，之后再也读不出来。把它放进环境变量 `DATAXAPI_API_KEY`，不要写进代码。

```bash
export DATAXAPI_API_KEY="<your key>"
```

### 2. 调一次

下面调的是 `tiktok.videos.search`，[TikTok 视频搜索](https://dataxapi.com/zh/apis/tiktok/videos/search/)。别的接口都是同样的调法。

cURL

```bash
curl -G "https://api.dataxapi.com/v1/tiktok/videos/search" \
  --data-urlencode "query=space station" \
  -H "Authorization: Bearer $DATAXAPI_API_KEY"
```

Python

```python
from dataxapi import DataXAPI

dx = DataXAPI()  # reads DATAXAPI_API_KEY
result = dx.tiktok.videos.search(query="space station")
print(result["data"]["items"])
```

TypeScript

```ts
import { DataXAPI } from "@dataxapi/sdk";

const dx = new DataXAPI(); // reads DATAXAPI_API_KEY
const result = await dx.tiktok.videos.search({ query: "space station" });
console.log(result.data.items);
```

CLI

```bash
dataxapi call tiktok.videos.search 'query=space station'
```

Python 和 TypeScript 两种写法用的是 [SDK](https://dataxapi.com/zh/docs/sdk/)，最后一种用的是[命令行](https://dataxapi.com/zh/docs/cli/)。

这次调用的价格是每次 $0.0020。失败的调用不扣费。[在 Playground 里跑一次](https://dataxapi.com/zh/console/playground/)：要先登录，花的是你自己的余额。

下面是一份录下来的真实返回，只留了第一条。名字、正文和编号是示例，链接也是，数字是原样；请求号、游标和余额是编的。

```json
{
  "code": "ok",
  "request_id": "eecdbf3f-64ce-4b11-b396-ee190d7ff728",
  "data": {
    "items": [
      {
        "id": "7566364515678793552",
        "url": "https://www.tiktok.com/@trail_and_lens/video/7566364515678793552",
        "type": "video",
        "text": "My honest take on space station, a month in.",
        "lang": "en",
        "published_at": "2026-10-11T23:17:34.000Z",
        "author": {
          "id": "6279025233109159764",
          "username": "trail_and_lens",
          "name": "Maya Chen",
          "avatar_url": "https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068/fff322a0d982cccf1e82~c5_100x100.jpeg",
          "followers": 92601
        },
        "metrics": {
          "likes": 353,
          "comments": 11,
          "shares": 19,
          "favorites": 40,
          "views": 7561
        },
        "hashtags": [
          "weekendvibes",
          "gearreview"
        ],
        "mentions": []
      }
    ]
  },
  "page": {
    "next_cursor": "c1.bGY_kn5Dxsgl6MN3VXHyMcLAdlxPxQw-FwjswIlE",
    "cursor_expires_at": "2026-10-12T20:17:24.000Z",
    "has_more": true,
    "returned": 30
  },
  "warnings": [],
  "meta": {
    "capability": "tiktok.videos.search",
    "result_status": "complete",
    "fetched_at": "2026-10-12T19:17:24.000Z",
    "cached": false,
    "replayed": false,
    "unavailable": {
      "title": "platform",
      "images": "capability",
      "author.verified": "capability",
      "metrics.reposts": "capability",
      "mentions.username": "capability",
      "mentions.name": "capability",
      "post_id": "platform",
      "parent_id": "platform",
      "root_id": "platform",
      "is_pinned": "capability"
    },
    "billing": {
      "amount": "0.002",
      "currency": "USD",
      "balance_after": "9.998"
    }
  }
}
```

要知道的四样：

- `data.items`: 数据本身：一组标准对象，这里是 [post](https://dataxapi.com/zh/docs/objects/post/)。同一种对象在每个平台上字段都一样。
- `page.next_cursor`: 传回去当 `cursor` 就是下一页；没有下一页时是 `null`。每一页是单独的一次调用。
- `meta.unavailable`: 这个接口给不了的字段，各带原因。`data.items` 里没有、这里列着的字段，不是出了错。
- `meta.billing`: 这次扣了多少（`amount`），扣完余额还剩多少（`balance_after`）。

> 出错时换成同一种结构返回：`code`、`message`、`charged`、`retry`。比如余额不够是 [`insufficient_balance`](https://dataxapi.com/zh/docs/errors/#insufficient_balance)，`charged` 为 false，这次不扣钱。全部报错见[错误码](https://dataxapi.com/zh/docs/errors/)。

### 3. 接进 AI

不想写代码，就把下面这句话复制给 Claude Code、Cursor、Codex 这类能动手的 AI。它会读说明、接好 MCP，之后你直接用中文问就行。

```text
读 https://dataxapi.com/agents.md，在这个 agent 里帮我接好 DataXAPI。我的 API Key 是 dx_…，之后所有 DataXAPI 的调用都用它。
```

> 把 `dx_…` 换成你自己的 Key。控制台的[接入 AI 页](https://dataxapi.com/zh/console/connect/)会连同一把专门给它用的 Key 一起复制好。

想自己配也行。MCP 地址是 `https://api.dataxapi.com/mcp`，接上后 AI 会拿到 5 个工具：

- `find`: 按一句需求找到该用的接口。
- `describe`: 一次看最多 5 个接口的全部：参数、字段、价格。
- `call`: 调用一个接口，返回一页数据。
- `read_more`: 24 小时内重读一份结果。
- `account`: 余额、用量和每次调用的扣费。

## 接下来

- [鉴权](https://dataxapi.com/zh/docs/authentication/)：多建几把 Key，每把各有上限、到期时间和范围。
- [请求与返回](https://dataxapi.com/zh/docs/requests/)：参数名和返回格式，21 个平台都一样。
- [翻页](https://dataxapi.com/zh/docs/pagination/)和[计费](https://dataxapi.com/zh/docs/billing/)：下一页怎么取，花多少钱。
- [限流](https://dataxapi.com/zh/docs/rate-limits/)和[错误代码](https://dataxapi.com/zh/docs/errors/)：什么时候等，什么时候停。
- [SDK](https://dataxapi.com/zh/docs/sdk/)、[命令行](https://dataxapi.com/zh/docs/cli/)和 [MCP 服务](https://dataxapi.com/zh/docs/mcp/)。
- [全部 207 个接口](https://dataxapi.com/zh/apis/)，每个一页，页面上写着价格。

---

目录修订号 c48ce454ae6c4c65。 [网页版](https://dataxapi.com/zh/docs/quickstart/)