Developer API の概要

Developer API とは

Cognivo Developer API を使うと、Cognivo Chat、dApp、Telegram ボットを支えているのと同じオンチェーンインテリジェンスを、自分のコードから呼び出せます。プロジェクトを作成し、API キーを作成し、通常の HTTPS でリクエストを送るだけです。

1. Developers エリアは、プロジェクトを作成し、Cognivo API キーを管理する場所です。
2. サインインを選択すると、開発者ポータルを開きます。キーはあなたのアカウント専用の非公開のままです。

Cognivo dApp の Developers ページ。画像を拡大

使いどころ

Cognivo の中ではなく、自分が作っているものの中で Cognivo の回答を使いたいときに利用します。よくあるケースは次のとおりです。

• コミュニティボット。誰かがコントラクトアドレスを貼ると、リスクシグナル、流動性とロックの状況、トークンが下落している理由の読み解きが返ってきます。
• トレジャリー、チーム、ホエールウォレットの監視ダッシュボード。承認によるエクスポージャー、直近の資金移動、トークンごとの実現損益などを扱えます。
• リサーチ用のノートブック。調査や事後検証のために、トークンとウォレットのデータを Python や JavaScript に取り込みます。

これは生のノードや RPC へのアクセスではありません。呼び出すのは常に厳選された Cognivo のエンドポイントです。取引、注文執行、MEV 向けのツールはありません。結果はインテリジェンスのシグナルであって金融アドバイスではなく、問題のない結果が出たからといってトークンが安全だということにはなりません。

見つけ方

dApp でサイドバーを開き、Account、次に Developers を選びます。直接のリンクは dapp.cognivolabs.io/en/developers です。通常の Cognivo アカウントでサインインしている必要があります。サインアウトしている場合、このページには案内画面だけが表示され、プロジェクトもキーも表示されません。

dApp の Developers ページの上部。ベース URL と API キーの送り方を、ここで確認できます。画像を拡大

ページ上部のカードには、最初の呼び出しに必要な 3 つの情報が載っています。

• Base URL: https://api.cognivolabs.io。ここにエンドポイントのパスを付けてリクエストします。
• Auth: すべてのリクエストで API キーを X-API-Key ヘッダーに載せて送ります。キーはサーバー側に保管し、ブラウザーのコードには決して置かないでください。
• Chains: ページには Ethereum, Base, and BSC live と More chains coming soon が表示されます。対応チェーン数がほかより少ないエンドポイントもあり、どれがどうかは エンドポイントリファレンス に記載されています。

同じカードから、このドキュメントと、機械可読な OpenAPI 仕様 にリンクしています。仕様は Postman、Insomnia、SDK ジェネレーターに読み込めます。

ページ自体には 4 つのタブがあります。Quickstart、Keys、Endpoints、Usage です。Endpoints はコピーできる例と各呼び出しの価格を備えたリファレンスです。ページ上に実行機能はないので、そこを読むだけで費用が発生することはありません。

アクセス、キー、費用

ライブキーはセルフサービスです。作成すればすぐに使え、申請も承認待ちもありません。ポータルはモデルを率直に示しています。有効なキーがあれば無料で使えるエンドポイントもあれば、有料または Enterprise のアクセスが必要で、成功した呼び出しごとに Cognivo のクレジット残高から課金されるエンドポイントもあります。

• ライブキー（cogv_live_）は実際の呼び出しを行います。成功した呼び出しごとに、そのエンドポイントに公開されている価格で Cognivo クレジットが課金されます。失敗した呼び出しに課金されることは決してありません。現在、Developer API の呼び出しに対する課金はオフになっており、成功した呼び出しでも何も差し引かれず、残高は変わりません。
• テストキー（cogv_test_）はポータル上で Test と表示されます。厳しい上限があり、実際のトラフィックではなく API を試すためのものです。
• すべてのキーは Keys タブに アクセスモード を表示します。Paid、Trial、Partner、Sandbox、Enterprise、Request access などです。Request access のキーは、有料エンドポイントを実行する前に承認が必要で、Suspended のキーは何も呼び出せません。ポータルにその理由が表示されます。
• Enterprise はアクセスを申請する唯一の経路で、カスタムの価格と上限に対応します。Enterprise access のボタンからサポートのフローが開きます。

クレジットは Cognivo のほかの場所で使うのと同じ残高から支払われ、すべてのアカウントには 1 日 5 クレジットの無料枠があり、UTC の深夜 0 時にリセットされます。残高が呼び出しをまかなえない場合は payment_required というコードの 402 エラーが返り、課金はされません。チャージしてからもう一度お試しください。残高の仕組みは Billing and credits をご覧ください。

GET /v1/api/health は無料でキーも不要です。GET /v1/api/me は有効なキーがあれば無料です。GET /v1/api/discover は無料ですが、1 日あたりの上限が厳しく設定されています。エンドポイントごとの価格は エンドポイントリファレンス と レート制限、エラー、課金 にあります。

返ってくる内容と、空の回答の意味

レスポンスに含まれるのは公開されたオンチェーンインテリジェンスだけです。あなたのものであれ他人のものであれ、Cognivo のアカウント識別子、メールアドレス、残高、その他の非公開のアカウントデータが含まれることはありません。唯一の例外は GET /v1/api/me で、支出を把握できるように、呼び出したキー自身のクレジット残高を返します。

空のフィールドや不明な値は、そのチェーン上のそのトークンやウォレットについて、Cognivo がその項目を検証できなかったという意味です。その項目が存在しないという意味ではなく、対象に問題がないという意味でもありません。結果が欠けている場合は未検証として扱い、追跡が必要ならレスポンスのリクエスト ID を使ってください。

次のステップ

1. サインインしてプロジェクトを作成し、ライブキーを作成します。完全なキーは一度しか表示されないので、すぐにコピーしてください。
2. クイックスタート で最初の呼び出しを実行します。
3. 権限、ローテーション、キーの安全な扱いについては 認証と API キー をお読みください。