跳轉到主要內容

Documentation Index

Fetch the complete documentation index at: https://docs.raydium.io/llms.txt

Use this file to discover all available pages before exploring further.

本頁內容由 AI 自動翻譯,所有內容以英文版本為準。查看英文版 →
端點級文件位於 API Reference 頁籤。 每個端點都有一個由 Mintlify 的 OpenAPI 遊樂場驅動的互動式 Try it 面板——在瀏覽器中填入參數並直接命中活躍主網(或開發網,如有提供)。本頁是敘述性伴讀:存在哪些服務、何時使用哪個,以及跨越所有服務的慣例。如果你在尋找「GET /pools/info/ids 接受什麼」,點選進入 API Reference;如果你在尋找「我應該整合哪個服務」,繼續閱讀。

十一個服務一覽

Raydium 執行十一個公開 HTTP 服務。每個服務都在 API Reference 頁籤中作為自己的群組記錄,並有 OpenAPI 規格支持互動式遊樂場。
服務主網主機開發網主機提供的內容
API v3api-v3.raydium.ioapi-v3-devnet.raydium.io規範流動性池 / 代幣 / 設定 / 鏈信息讀取 API。UI 和大多數整合者的預設前門。
Transaction APItransaction-v1.raydium.iotransaction-v1-devnet.raydium.io伺服器端交換交易構建。
Perps APIapi-perp-v1.raydium.ioRaydium Perps 前端的設定、資產元數據、RPC 選擇。
LaunchLab Mint APIlaunch-mint-v1.raydium.iolaunch-mint-v1-devnet.raydium.io代幣搜尋、索引、排行榜、每個代幣的元數據。
LaunchLab History APIlaunch-history-v1.raydium.iolaunch-history-v1-devnet.raydium.ioLaunchLab 池的交易歷史和 OHLC K 線聚合。
LaunchLab Forum APIlaunch-forum-v1.raydium.iolaunch-forum-v1-devnet.raydium.ioLaunchLab 發行版上的評論執行緒和 IPFS 上傳。錢包簽名。
LaunchLab Auth APIlaunch-auth-v1.raydium.iolaunch-auth-v1-devnet.raydium.io從錢包簽名訊息鑄造短期 ray-token JWT。Forum 所需。
Dynamic IPFS APIdynamic-ipfs.raydium.iodynamic-ipfs-devnet.raydium.io動態 NFT(CLMM 頭寸等)的圖像 / 元數據重新生成。
Owner APIowner-v1.raydium.ioowner-v1-devnet.raydium.io每個錢包的頭寸、餘額、可領取獎勵。
API v1(舊版)api.raydium.io為尚未遷移到 API v3 的用戶端保持的舊版 /v1/v2 路徑。
Temp APItemp-api-v1.raydium.iotemp-api-v1-devnet.raydium.io短期臨時端點的存放區。表面可能在不通知的情況下變更。
版本控制位於 v3 / v1 服務的主機名稱中——沒有進一步的路徑級版本控制。破壞性變更作為具有重疊的新主機推出;團隊已公開承諾任何 v3 → v4 遷移至少 6 個月的重疊。

選擇服務

如果你想要…使用
讀取池元數據、價格、APR、費用設定API v3
讀取代幣元數據(名稱、符號、標誌、小數、風險標籤)API v3 /mint/list/mint/price
在伺服器端構建交換 / 添加流動性 / 移除流動性交易Transaction API
顯示錢包的頭寸(LP 代幣、CLMM 頭寸、農場質押)Owner API
搜尋 LaunchLab 代幣、瀏覽排行榜、取得每個代幣的元數據LaunchLab Mint API
為 LaunchLab 池繪製 K 線 / 蠟燭圖LaunchLab History API
在 LaunchLab 發行版上發佈或讀取評論LaunchLab Auth APIray-tokenLaunchLab Forum API
繪製 CLMM 頭寸 NFT 圖像Dynamic IPFS API
為 Perps UI 顯示期貨市場設定或資產清單Perps API
與 v1/v2 路徑前綴用戶端保持相容性API v1(舊版)

跨領域慣例

回應信封

除 IPFS 外的每個服務都返回相同的 JSON 信封:
{
  "id":      "uuid-v4-per-request",
  "success": true,
  "data":    { ... }
}
失敗時:
{
  "id":      "uuid-v4-per-request",
  "success": false,
  "msg":     "human-readable error string",
  "data":    null
}
某些服務另外包括 error.code 整數(API v3 用此作為跨次要版本的穩定錯誤識別符)。見各服務的概覽頁面以了解確切的形狀。

驗證

有兩種模式:
  • 無驗證——除 Forum 外的每個服務。透過 HTTPS 匿名命中。
  • 錢包簽名握手——LaunchLab Forum API 所需。用你的錢包簽名一個形式為 time:<unix-seconds> 的 Solana ed25519 訊息,將簽名 + 錢包地址發送至 LaunchLab Auth API /request-token,接收一個 JWT,並在後續論壇呼叫中將其作為 ray-token 請求標頭傳遞。
Mintlify 遊樂場在發送論壇請求前在驗證面板中接受 ray-token;該值僅保存在你的瀏覽器中。

速率限制

所有主機都位於 Cloudflare 後面,每個來源 IP 採用漸進式速率限制。為整合者發佈的指南: 超過發佈限制的突發返回 HTTP 429Retry-After 標頭。需要更高限制的聚合器或機器人應聯繫 Raydium 團隊,而不是對公開主機進行敲擊——針對鏈上程式 ID 運行你自己的索引器也是讀取密集工作負載的選項。

快取和一致性

  • 大多數 API v3 讀取端點在邊界快取 5–60 秒;具體的 TTL 在每個端點的 API Reference 頁面上標記。
  • 快取由索引器在觀察到的程式接觸事件上失效。
  • 在大型重組或擁塞期間,API 的視圖與鏈上狀態可能有 1–2 個時隙的分歧。SDK 和直接 RPC 讀取始終更新——如果用戶端即將簽名交易,透過 RPC 重新取得相關帳戶,絕不盲目信任 API 值。

錯誤格式

錯誤以 HTTP 4xx/5xx 返回,使用相同的信封(success: false,填充的 msg)。API v3 另外包括穩定的 error.code
{
  "id":      "uuid-v4-per-request",
  "success": false,
  "msg":     "Pool not found",
  "error":   { "code": 40401, "message": "Pool not found" }
}
error.code 在次要 API 版本中是穩定的;在用戶端邏輯中將其視為主要信號,msg 作為人類可讀的表面。

代幣對參數慣例

許多 API v3 端點接受 mint1=…&mint2=… 並要求 mint1 < mint2(升序公鑰字節順序)。這樣 API 可以返回相同的規範池,不管呼叫者的首選參數順序。在構建 URL 前在用戶端排序這兩個代幣——API Reference 中的端點級文件在適用的地方重複此約束。

推薦的用戶端模式

  1. 一次補水,懶惰刷新。 在應用程式加載時取得 GET /main/infoGET /mint/list(均在 API v3 上)並在本地快取,TTL 為 1 小時。兩者都被大量邊界快取且很少變更。
  2. 在端點允許的地方批量操作。 GET /pools/info/ids?ids=… 接受逗號分隔清單——在一個請求中取得十個池,而非十個請求。
  3. 避免熱路徑價格取得。 GET /mint/price 對 UI 渲染很好;絕不在機器人中迴圈。對於交易機器人,運行一個索引器或直接訂閱 RPC programSubscribe 事件。
  4. 為高吞吐量鏡像或代理。 超過發佈速率限制上限的任何內容都應從你自己的快取層提供,而不是直接從公開主機。對 transaction-v1 有持續 >120 req/min 的聚合器應該運行他們自己的報價 / 路由引擎。
  5. 在簽名前重新取得。 API 回應可能有 5–60 秒的過時。對於簽名時實際正確的池快照,透過 SDK 或直接 RPC getMultipleAccounts 呼叫重新讀取相關帳戶。將 API 值視為查閱提示,而不是結算來源。
  6. 為低摩擦整合使用 Transaction API。 如果你不想在用戶端中捆綁 SDK(行動原生、受限環境中的機器人),Transaction API 將返回一個 base64 編碼的版本化交易供使用者簽名。它返回的 swapResponse 內嵌一個報價——將其視為對 ~30 秒有效。

接下來的去向

  • 端點參考(互動)API Reference。每個服務都有自己的群組;點選任何端點以獲得參數、回應形狀、程式碼範例和 Try-it 面板。
  • TypeScript SDKsdk-api/typescript-sdk。SDK 內部在幾個路徑上使用 API v3;對於交易構建,它始終從 RPC 重新取得狀態,絕不盲目信任 API。
  • Trade API 整合integration-guides/aggregator。將 Raydium 流動性連接到多 DEX 聚合器的模式。
  • AI 友善文件sdk-api/ai-integration。為需要呼叫這些 API 的 AI 程式設計代理的指標。