# 端点

> Ora API 中 API 密钥可以调用的所有路由。

API 向密钥开放的所有路由。所有路由都需要密钥。路径均相对于 `https://api.useora.xyz`；`{address}` 和 `{mint}` 是代币的 mint（Solana）或合约（EVM）。

### 账户

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/auth/me` | 你的账户信息，包括 API 访问权限是否已开通（`apiAccess`）以及是否存在密钥（`hasApiKey`）。 |
| `POST` | `/me/api-key` | 创建一个新的 API 密钥，并仅返回一次。之前的密钥会立即失效。 |
| `POST` | `/me/api-key/revoke` | 撤销你的 API 密钥：此后使用它发出的每次调用都会被拒绝。 |
| `POST` | `/me/referral-code` | 设置自定义推荐码。 |
| `GET` | `/me/rewards` | Rewards 窗口和个人资料卡片上的全部内容：积分、排名、在途和待领取的奖励（`balance`）、推荐收益和被推荐人。 |
| `POST` | `/rewards/claim` | 领取你的奖励：将你全部的 **Rewards to claim**（已到达奖励池的返现和推荐分成）通过一笔转账以 SOL 发送到你的 Ora 钱包。网络费用从发送金额中扣除。返回该笔转账的 `signature` 和发送的 `lamports`；没有可领取的奖励时返回 `404`。 |
| `GET` | `/me/settings` | 你的应用偏好设置，即通过 `PUT /me/settings` 保存的内容。 |
| `PUT` | `/me/settings` | 整体替换你的应用偏好设置（不做合并）。 |
| `GET` | `/user/pinned-tokens` | 你置顶的代币。 |
| `POST` | `/user/pinned-tokens` | 置顶某个代币；如果它已置顶，则取消置顶。 |
| `GET` | `/user/tracked-wallets` | 你追踪的钱包。 |
| `POST` | `/user/tracked-wallets` | 添加要追踪的钱包，可一次添加多个。 |
| `DELETE` | `/user/tracked-wallets/{address}` | 停止追踪某个钱包。 |
| `PATCH` | `/user/tracked-wallets/{address}` | 重命名某个被追踪的钱包，或更改它的表情符号。 |
| `GET` | `/user/tracked-wallets/trades` | 你所追踪钱包的近期交易。 |
| `GET` | `/user/tracked-wallets/trades/stream` | 你所追踪钱包的实时交易（数据流）。 |

### 发射

| 方法 | 路径 | 作用 |
|---|---|---|
| `POST` | `/engine/deploy/plan` | 一次调用即可为发射给出钱包和分层布局建议，并附带完整的成本和市场预估。 |
| `POST` | `/engine/deploy/wallets/add` | 自定义钱包：添加持有者钱包，并返回重新计算后的方案（钱包、分层、报价和预估）。 |
| `POST` | `/engine/deploy/wallets/allocation` | 自定义钱包：设置一个或多个持有者的分配比例，并返回重新计算后的方案。 |
| `POST` | `/engine/deploy/wallets/remove` | 自定义钱包：移除持有者，并返回重新计算后的方案。 |
| `GET` | `/engine/launch-bounds` | 发射必须达到的最低 Supply Buy % 和 Dev Buy %。 |
| `POST` | `/engine/drafts` | 创建发射草稿。 |
| `GET` | `/engine/drafts/{id}` | 加载发射草稿。 |
| `PUT` | `/engine/drafts/{id}` | 保存发射草稿。 |
| `POST` | `/engine/drafts/{id}/archive` | 删除发射草稿。 |
| `GET` | `/engine/launches/drafts` | 所有尚未发射的内容：发射草稿，以及已上传但从未准备的代币信息。 |
| `POST` | `/engine/prepare` | 准备发射：创建代币的 mint、草稿代币及其钱包。 |
| `POST` | `/engine/{mint}/delete` | 删除仍在准备中的代币及其钱包。 |
| `POST` | `/engine/fund` | 构建为发射钱包注资的未签名 SOL 转账，供你的钱包签名。 |
| `GET` | `/engine/fund/{mint}` | 为某个代币记录的 Private Funding 各部分。 |
| `POST` | `/engine/fund/confirm` | 确认注资交易已上链。 |
| `POST` | `/engine/fund/verify` | 根据钱包余额核对直接注资。 |
| `POST` | `/engine/launch` | 将已准备好的代币发射上链。 |
| `POST` | `/engine/cancel` | 构建交易，从处于准备中、已注资或已失败的发射的钱包中收回 SOL。交易由 Ora 部分签名；其余由你的钱包签名。 |
| `POST` | `/engine/cancel/submit` | 提交已签名的取消交易。 |
| `POST` | `/engine/collect` | 构建收取发射收益的交易。交易由 Ora 部分签名；其余由你的钱包签名。 |
| `POST` | `/engine/collect/submit` | 针对某个 `collectId` 提交已签名的收取交易。 |
| `GET` | `/engine/token/{address}/pre-deploy` | 已准备但尚未发射的代币的发射成本预估。 |

### 交易

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/engine/tokens` | 你的代币，按状态列出。 |
| `GET` | `/engine/token/{address}` | 代币的基本信息：元数据、供应量和发射状态。 |
| `GET` | `/engine/token/{address}/positions` | 你的钱包在某个代币上的持仓：持有量、SOL 余额、已实现和未实现 PnL、运行中的策略预留的部分（`lockedTokens`、`lockedQuote`），以及 `totals`。 |
| `PATCH` | `/engine/token/{address}/position/wallet-name` | 重命名某个代币的其中一个钱包（即持仓表格中显示的名称）。 |
| `POST` | `/engine/token/{address}/position/buy` | 在你的多个钱包中买入。 |
| `POST` | `/engine/token/{address}/position/sell` | 在你的多个钱包中卖出。 |
| `POST` | `/engine/token/{address}/position/nuke` | 一次性卖出所有持仓（紧急退出）。 |
| `POST` | `/engine/token/{address}/position/send/preview` | 在你确认发送之前给出报价。 |
| `POST` | `/engine/token/{address}/position/send` | 从你的一个或多个 Ora 钱包向最多 5 个外部地址发送代币。Ora 的手续费以代币收取，并在同一个捆绑交易中卖出换成 SOL。 |
| `POST` | `/engine/token/{address}/burn` | 从你的某个钱包中销毁代币。此操作无法撤销。 |
| `POST` | `/engine/token/{mint}/lock` | 将你某个 Ora 钱包中的代币锁定到 Streamflow 时间锁中。 |
| `POST` | `/engine/token/{mint}/lock/withdraw` | 将某个锁定释放回创建它的钱包。 |
| `GET` | `/engine/token/{mint}/locks` | 某个代币的锁定记录。 |
| `GET` | `/engine/burns/{mint}` | 某个代币的销毁历史。 |
| `GET` | `/engine/sends/{mint}` | 某个代币的发送历史。 |
| `GET` | `/engine/token/{address}/creator-rewards` | 某个代币累计的创作者奖励。 |
| `POST` | `/engine/reward-claim` | 领取 Pump.fun 创作者金库中累计的创作者奖励。 |
| `POST` | `/engine/token/{mint}/layers` | 为你已发射的代币添加一层持有者（即一次清理），由你自己的、未被任何发射占用的老钱包或导入钱包（`walletIds`）平均填充。 |
| `GET` | `/engine/unlock/{mint}` | 可以从中归集 SOL 的代币钱包（余额高于预留额，从大到小排列）、每个钱包的可用数量、收款钱包以及允许的范围。 |
| `POST` | `/engine/unlock` | 将你选择的 SOL 数量从某个代币的钱包归集到它的收款钱包。每个来源钱包各自支付手续费。 |
| `POST` | `/engine/token/{address}/callouts/watch` | 开启或续期该代币的喊单：在一段时间内，它的 FOMO 和 Pump.fun 喊单会被定期抓取，并实时推送给你。 |

### 策略

这些路由保留了 `-sells` 的名称，但同样用于管理买入策略：创建时传入 `side: "buy"` 即可。参见[买入策略](https://docs.useora.xyz/developers/guides/#buy-strategies)。

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/engine/strategies` | 某个代币的所有策略，无论卖出还是买入：Mirror、TWAP 和 Limit。 |
| `GET` | `/engine/strategies/limit-sells` | 某个代币的 Limit 卖出策略。 |
| `POST` | `/engine/strategies/limit-sells` | 为某个代币创建一个或多个 Limit 卖出策略；传入 `side: "buy"` 则创建 Limit 买入策略。 |
| `PATCH` | `/engine/strategies/limit-sells/{id}` | 编辑某个 Limit 卖出策略（仅修改你发送的字段）。 |
| `POST` | `/engine/strategies/limit-sells/{id}/enable` | 启用某个 Limit 卖出策略。 |
| `POST` | `/engine/strategies/limit-sells/{id}/disable` | 停用某个 Limit 卖出策略。 |
| `DELETE` | `/engine/strategies/limit-sells/{id}` | 删除某个 Limit 卖出策略。 |
| `GET` | `/engine/strategies/mirror-sells` | 某个代币的 Mirror 卖出策略。 |
| `POST` | `/engine/strategies/mirror-sells` | 为某个代币创建一个或多个 Mirror 卖出策略；传入 `side: "buy"` 则创建 Mirror 买入策略。 |
| `PATCH` | `/engine/strategies/mirror-sells/{id}` | 编辑某个 Mirror 卖出策略（仅修改你发送的字段）。 |
| `POST` | `/engine/strategies/mirror-sells/{id}/enable` | 启用某个 Mirror 卖出策略。 |
| `POST` | `/engine/strategies/mirror-sells/{id}/disable` | 停用某个 Mirror 卖出策略。 |
| `DELETE` | `/engine/strategies/mirror-sells/{id}` | 删除某个 Mirror 卖出策略。 |
| `GET` | `/engine/strategies/twap-sells` | 某个代币的 TWAP 卖出策略。 |
| `POST` | `/engine/strategies/twap-sells` | 为某个代币创建一个或多个 TWAP 卖出策略；传入 `side: "buy"` 则创建 TWAP 买入策略。 |
| `PATCH` | `/engine/strategies/twap-sells/{id}` | 编辑某个 TWAP 卖出策略（仅修改你发送的字段）。 |
| `POST` | `/engine/strategies/twap-sells/{id}/enable` | 启用某个 TWAP 卖出策略。 |
| `POST` | `/engine/strategies/twap-sells/{id}/disable` | 停用某个 TWAP 卖出策略。 |
| `DELETE` | `/engine/strategies/twap-sells/{id}` | 删除某个 TWAP 卖出策略。 |

### 投资组合

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/portfolio/stats` | 投资组合统计数据。 |
| `GET` | `/portfolio/performance` | 某个时间范围内的投资组合表现（默认：全部时间）。 |
| `GET` | `/portfolio/coins` | 你尚未平仓的代币持仓。 |
| `GET` | `/portfolio/history` | 你已平仓的持仓。 |
| `GET` | `/portfolio/pnl-calendar` | 每日 PnL 日历。 |
| `GET` | `/portfolio/pnl-chart` | 随时间累计的已实现 PnL，用于图表。 |
| `GET` | `/portfolio/launches` | 你的发射项目，以及它们的余额和钱包中剩余的持仓。 |
| `GET` | `/portfolio/launches-chart` | 每个时段的发射数量，用于图表。 |
| `POST` | `/portfolio/launches/{id}/archive` | 归档某个发射项目；如果它已归档，则取消归档。 |
| `GET` | `/engine/launches/completed` | 你创建的所有已有 mint 的代币，无论状态如何（即 Launches 页面）。 |
| `GET` | `/portfolio/wallets` | 一个或多个发射项目的钱包，以及每个钱包仍持有的资产。 |
| `GET` | `/portfolio/wallets/available` | 未被任何发射占用的钱包（购买或导入的），并附带它们的 `source`，以及 `POST /engine/prepare` 用作 `warmWalletId` 的 `id`。 |
| `POST` | `/portfolio/wallets/import` | 通过你自己的私钥导入钱包（`source: imported`）。 |
| `POST` | `/portfolio/wallets/exit-preview` | 在任何资金转移之前，按代币逐一预览带 `destination` 的 `POST /portfolio/wallets/exit` 会通过 Husher 为这些钱包发送什么。 |
| `POST` | `/portfolio/wallets/exit` | 通过 Husher 将 `walletAddresses` 中的钱包提取到 `destination` 地址：每个钱包向各自的 Husher 充值地址付款，Husher 再按每种代币向 `destination` 付款一次（每种代币最多 70 个钱包，从大到小排列）。请务必发送 `destination`。应用中的 **Consolidate Withdraw** 会把它们发送到你的 Ora 钱包。 |
| `GET` | `/portfolio/wallets/exits` | 你最近 20 次从发射钱包提取的记录，每种代币一条，最新的排在最前，并附带进度。 |

### 市场

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/portfolio/marketplace/wallets` | 在售的老钱包：注资满一天且有一笔已上链的买入后上架，尚无人拥有，且未被其他买家预留。 |
| `POST` | `/portfolio/marketplace/quote` | 为某条链上的老钱包报价，并为你预留约 2 分钟。 |
| `POST` | `/portfolio/marketplace/buy` | 支付一份报价：按原有顺序、原样发送已签名的存入交易（否则返回 `409`）。由 Ora 广播这些交易。 |

### 行情数据与报价

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/engine/token/{address}/metrics` | 代币指标：市值、价格、流动性和供应量。 |
| `GET` | `/engine/token/{address}/candles` | 一页 OHLCV K 线，最早的排在最前：返回 `before` 之前最多 `limit` 根（默认值和最大值均为 300）K 线；不传 `before` 时返回最新的 K 线。 |
| `GET` | `/engine/token/{address}/live-stats` | 在一个响应中返回所有时间范围（5m、1h、6h、24h）的实时交易统计：买入、卖出、交易量、独立交易者数、持仓分布和价格变化。 |
| `GET` | `/engine/token/{address}/trades` | 某个代币的近期交易，最新的排在最前，可选按钱包、金额和时间筛选。 |
| `GET` | `/engine/token/{address}/holders` | 某个代币的持有者，包含每个持有者的余额和供应量占比，并标明哪些钱包是你的。 |
| `GET` | `/engine/token/{address}/top-traders` | 某个代币的顶级交易者，按 PnL 排名。 |
| `GET` | `/tokens/{mint}/trades` | 某个代币的公开交易动态。 |
| `GET` | `/tokens/{mint}/holders` | 某个代币的头部持有者，从大到小排列，分页返回。 |
| `GET` | `/quote/sol-for-percent` | 买入给定百分比的供应量所需的 SOL。 |
| `GET` | `/quote/tokens-for-sol` | 以最小单位（Solana 上为 lamports，EVM 上为 wei）给定金额时可获得的代币数量。 |
| `GET` | `/launchpads/{protocol}/quotes` | 某个发射平台在其所在链上接受的配对资产，原生币排在最前。 |
| `GET` | `/launchpads/pumpfun/charities` | 按名称搜索 donate.gg 上处于活跃状态的慈善机构，用于 `POST /engine/prepare` 中的 `pumpfunFeeShares`（`kind: 'charity'`，`charityId` = `id`）。 |
| `GET` | `/market/lighthouse` | 市场脉搏，即应用页脚中显示的内容。 |
| `GET` | `/pnl/calendar` | 每日 PnL 日历数据。 |
| `GET` | `/pnl/summary` | PnL 汇总，即 PNL 卡片上显示的内容。 |

### 代币信息

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/tokens` | 代币信息，最新的排在最前。 |
| `GET` | `/tokens/{id}/image` | 按代币信息 ID 获取某个代币处理后的图片。 |
| `GET` | `/tokens/{id}/banner` | 按代币信息 ID 获取某个代币处理后的横幅。 |
| `GET` | `/tokens/{mint}/logo` | 按 mint 获取某个代币的 logo（仅限你的代币）。 |
| `GET` | `/tokens/{mint}/cover` | 按 mint 获取某个代币的横幅（仅限你的代币）。 |
| `POST` | `/upload` | 上传代币信息。 |
| `POST` | `/upload/{protocol}` | 为某个发射平台上传代币信息。 |
| `POST` | `/upload/bags` | 为 Bags 上传代币信息。 |

### 数据流

| 方法 | 路径 | 作用 |
|---|---|---|
| `GET` | `/engine/tokens/{mint}/stream` | 在一个连接上获取某个代币的全部数据：状态事件、交易、已知的持有该代币的钱包，以及持有者统计。 |
| `GET` | `/user/tracked-wallets/trades/stream` | 你所追踪钱包的实时交易。 |
| `GET` | `/sol-usd/events` | SOL/USD 价格。 |
| `GET` | `/blockhash/events` | 最新的区块哈希和区块高度，大约每 220 毫秒一次。 |
| `GET` | `/jito/tip-lamports/events` | Jito 小费下限的各分位数。 |
| `GET` | `/jito/tip-accounts/events` | Jito 小费账户列表。 |

[签名与数据流](https://docs.useora.xyz/developers/signing-and-streams/#real-time-streams)介绍了如何读取数据流。