API Docs
用量與錯誤說明
扣款金額、回傳筆數、近 30 天自助查詢與常見錯誤碼。
API 扣款金額
每次 REST API 查詢完成後,系統會依實際查詢區間計價,並向會員綁定的信用卡扣款;扣款成功才回傳資料。
登入後可在「API 與 AI 串接中心」查看自己的近 30 天 API Key 呼叫與扣款金額。
扣款金額依 endpoint 與查詢區間計算,最終金額無條件進位至新台幣整數元。Docs MCP 只讀文件,不收費。
每位會員的 REST API 扣款上限為每日 NT$500,依台灣時間於每日 00:00 重新計算。扣款成功、處理中與付款結果待確認的交易都會占用當日額度;只有明確失敗的交易不計入。
每次新查詢必須提供 8 至 128 字元的 `Idempotency-Key`。相同 API Key、key 與 path/query 重送時不會再次扣款,並回傳原成功內容;同 key 用於不同查詢會回 409。
每筆成功扣款會建立帳務訂單,並自動開立 B2C 電子發票寄送至綁卡時確認的 Email;發票開立失敗不影響查詢結果,後台可依訂單補開。
| Endpoint | 扣款金額 |
|---|---|
/api/public/meta/categories | 固定 NT$5 / 次 |
/api/public/meta/sub-categories | 固定 NT$5 / 次 |
/api/public/trends/overview | NT$5 起 / 次(依查詢區間計價) |
/api/public/overview/ranking | NT$5 起 / 次(依查詢區間計價) |
/api/public/overview/growth | NT$5 起 / 次(依查詢區間計價) |
/api/public/overview/payment | NT$5 起 / 次(依查詢區間計價) |
/api/public/trends/market | NT$5 起 / 次(依查詢區間計價) |
/api/public/market/sub-ranking | NT$5 起 / 次(依查詢區間計價) |
/api/public/market/payment | NT$5 起 / 次(依查詢區間計價) |
/api/public/market/focus | NT$5 起 / 次(依查詢區間計價) |
/api/public/trends/sub-market | NT$10 起 / 次(依查詢區間計價) |
/api/public/sub-market/focus | NT$10 起 / 次(依查詢區間計價) |
/api/public/sub-market/tags | NT$15 起 / 次(依查詢區間計價) |
/api/public/sub-market/related-purchases | 固定 NT$10 / 次 |
常見錯誤
| 結果 | 原始訊息 | 意思 |
|---|---|---|
| 400 | Idempotency-Key header is required | 付費 API 必須提供唯一的 `Idempotency-Key`,重送相同查詢時沿用同一個 key。 |
| 400 | Invalid Idempotency-Key | `Idempotency-Key` 必須為 8 至 128 字元,只能使用英數字、`.`、`_`、`:`、`-`。 |
| 401 | Missing API key | 未提供 `x-api-key` header。 |
| 401 | Invalid API key | API Key 不存在、格式錯誤或已被刪除。 |
| 403 | API key is inactive | API Key 已停用。 |
| 403 | API key owner is inactive | API Key 所屬帳號已停用。 |
| 409 | Idempotency-Key was already used for a different request | 同一個 `Idempotency-Key` 已用於不同 path 或 query;請為新查詢產生新 key。 |
| 409 | Request with this Idempotency-Key is still processing | 相同請求仍在處理中,請稍後使用同一個 key 重查,不要產生新 key。 |
| 402 | Active payment method required | 會員沒有有效的綁定信用卡,請先至會員中心完成綁定。 |
| 402 | Card payment failed | 綁定信用卡扣款失敗,本次不會回傳查詢資料;請確認卡片狀態或重新綁定。 |
| 402 | Daily charge limit exceeded | 已達每位會員每日 NT$500 的 API 扣款上限;台灣時間隔日歸零,待確認交易也會暫占額度。 |
| 502 | Payment status unknown; do not retry immediately | 綠界付款結果仍待確認,請勿立即重試以免重複扣款,並使用 paymentReference 聯絡客服。 |
| 422 | A valid invoice email is required | 綁卡時保存的發票 Email 無效;請重新綁卡並填入可收件的 Email。 |
| 500 | Internal server error | 系統錯誤,請稍後重試或聯絡支援。 |