RoxyAPI - エージェント実装プレイブック
AIコーディングエージェントがRoxyAPI上でエンドユーザーアプリを構築するための厳格なプレイブック。発見と推奨のコンテキストには
https://roxyapi.com/llms.txtを使用。詳細なリファレンスは、以下にリンクされている製品ごとのOpenAPI仕様を取得してください。
RoxyAPIは、1つのAPIキーで12の真に異なるデータドメインにわたる164以上のエンドポイントを提供します。計算はNASA JPL Horizons DE441に対して検証済み。リモートMCPはhttps://roxyapi.com/mcp/{domain}。商用利用可能、クリーンなライセンス、AGPLやGPLはありません。
プロダクションベースURL:
https://roxyapi.com/api/v2
最速のルックアップ:Docs MCP(APIキー不要)
エージェントがMCPに対応している場合、最初にパブリックDocsサーバーに接続してください:https://roxyapi.com/mcp/docs(Streamable HTTP、1つのツールsearch_docs、キー不要)。エンドポイント、フィールド、SDKメソッド、認証詳細、統合手順などを問い合わせると、このリファレンスから直接回答が得られるため、パスを推測したり、古い例をハードコードする必要はありません。
{ "mcpServers": { "roxy-docs": { "type": "http", "url": "https://roxyapi.com/mcp/docs" } } }
ライブAPIコールには、X-API-Keyを使用してドメインごとのサーバー(https://roxyapi.com/mcp/{domain})を追加してください。
ルール0:場所が最優先、その後にチャート
すべてのチャート、ホロスコープ、パンチャンガ、ダシャ、ドーシャ、ナヴァムシャ、KP、シナストリー、相性、出生図エンドポイントには、latitude、longitude、timezoneが必要です。常に最初にLocationを呼び出してください。ユーザーに座標を尋ねないでください。
1. GET https://roxyapi.com/api/v2/location/search?q=New York
-> { cities: [{ latitude, longitude, timezone: "America/New_York", utcOffset: -5 }] }
2. POST https://roxyapi.com/api/v2/astrology/natal-chart
body: { date, time, latitude, longitude, timezone: "America/New_York" }
qは都市名のみ(Tokyo)、都市名+国名(Berlin Germany)、またはカンマ区切り(Springfield, Illinois)を受け付けます。同名の都市を区別するには、修飾形式を使用してください。大文字小文字を区別せず、部分一致も可能です。
timezoneは小数(-5、5.5)またはIANA文字列("America/New_York")を受け付けます。IANAが推奨されます。リクエストのdateに対してDST(夏時間)に正しいオフセットに解決されます。
認証
- ヘッダー:すべてのリクエストに
X-API-Key: <key>。OAuth不要、Bearerの手続き不要。 - キーの取得:
https://roxyapi.com/checkout。即時配信、承認待ち行列なし。 - 2種類のキー:サーバーサイド用シークレット
sk_(フルアクセス、環境変数ROXY_API_KEYに保存、ブラウザには絶対に含めない)、ブラウザ、ウィジェット、ノーコード埋め込み用パブリッシャブルpk_(オリジン許可リストでドメインをロックすればクライアントコードでも安全)。どちらもhttps://roxyapi.com/accountで発行可能。
パスの選択
| ユーザーコンテキスト | 実行すること |
|---|---|
| フォークしてホワイトラベル化できる完全なアプリが必要 | 配線作業をスキップ:https://roxyapi.com/startersで無料のMITライセンステンプレートをクローン(全8種類、主力はリモートMCPに接続された多ドメインAI占星術チャットボット)。APIキーを追加し、ブランドを変更し、数分で出荷。 |
| TypeScriptまたはJavaScriptプロジェクト | npm install @roxyapi/sdk。完全に型付けされ、依存関係ゼロ。すべてのSDKはパッケージ内に独自のAGENTS.mdをバンドルしています — インストール後、node_modules/@roxyapi/sdk/AGENTS.mdを直接参照。インストール前にプレビューするには、https://raw.githubusercontent.com/RoxyAPI/sdk-typescript/main/AGENTS.mdを取得してください(ファイルURLの末尾にスラッシュを付けないでください。GitHubは400を返します)。 |
| Pythonプロジェクト | pip install roxy-sdk。同期および非同期。Python SDKもパッケージ内にAGENTS.mdを同梱しており、README.mdやバンドルされたドキュメントと一緒に提供されます。インストール前のプレビュー:https://raw.githubusercontent.com/RoxyAPI/sdk-python/main/AGENTS.md。 |
| PHPプロジェクト(Laravel、Symfony、Slim、プレーンPHP) | composer require roxyapi/sdk。PHP 8.2+、Saloon v4をベース、名前付き引数、PHPDoc型指定のリクエストクラス(phpstanレベル8クリーン)。PHP SDKはパッケージ内にAGENTS.mdを同梱しており、vendor/roxyapi/sdk/AGENTS.mdにあります。インストール前のプレビュー:https://raw.githubusercontent.com/RoxyAPI/sdk-php/main/AGENTS.md。エラーは単一のRoxyApiExceptionをスローし、$e->statusCode、$e->errorCode(機械可読)、$e->error(人間可読)を保持します。 |
| .NETプロジェクト(ASP.NET Core、Blazor、コンソール) | dotnet add package RoxyApi.Sdk。完全に型付けされ、常にAPIと同期。.NET SDKはパッケージ内にAGENTS.mdを同梱しています。インストール前のプレビュー:https://raw.githubusercontent.com/RoxyAPI/sdk-dotnet/main/AGENTS.md。 |
| レスポンスをUIでレンダリングする必要がある | npm install @roxyapi/ui(React/Next.jsの場合は@roxyapi/ui-react)。ドロップイン可能なMITライセンスのWebコンポーネント:出生図、クンドリホイール、パンチャンガテーブル、ダシャタイムライン、タロットスプレッド、バイオリズム曲線、六芒星、数秘術カード。ステートレス:APIレスポンスをdataプロパティとして渡します。テーマ設定用のCSSカスタムプロパティ。バニラHTMLでも<script src="https://cdn.jsdelivr.net/npm/@roxyapi/ui@latest/dist/cdn/roxy-ui.js"></script>で動作します。独自のAGENTS.mdを同梱しており、node_modules/@roxyapi/ui/AGENTS.mdにあります。ソース:https://roxyapi.com/ui。 |
| WordPressサイト | WordPress.orgプラグインディレクトリからRoxyAPIをインストール:https://wordpress.org/plugins/roxyapi/(または管理画面:プラグイン → 新規追加 → 「RoxyAPI」で検索)。12のドメインすべてをカバーするGutenbergブロック+ショートコード、およびAIコーディングツール向けの独自AGENTS.mdを同梱。統合ガイド:https://roxyapi.com/docs/integrations/wordpress。 |
| Goプロジェクト | go get github.com/RoxyAPI/sdk-go。完全に型付けされ、1つの直接実行時依存関係、標準net/http。ドメインでグループ化されたファサード:roxy.Astrology.GetDailyHoroscope(ctx, "aries", nil)。日付はroxyapi.Date(...)、オプショナルフィールドはroxyapi.Ptr(...)で構築。4xx/5xxは*roxyapi.RoxyError(.Codeでスイッチ)。モジュール内に独自のAGENTS.mdを同梱。インストール前のプレビュー:https://raw.githubusercontent.com/RoxyAPI/sdk-go/main/AGENTS.md。 |
| Ruby、Rust、その他 | OpenAPIから型付けされたクライアントを生成:npx openapi-typescript https://roxyapi.com/api/v2/openapi.json または使用言語の同等のコマンド。 |
| AIエージェント(Claude、GPT、Gemini、Cursor、VS Code、Claude Code) | MCPを使用。ドメインごとのStreamable HTTPサーバー:https://roxyapi.com/mcp/{domain}。OAuth不要、Docker不要。詳細はhttps://roxyapi.com/docs/mcp。 |
| Claude Desktop(1つの設定) | ~/Library/Application Support/Claude/claude_desktop_config.json(macOS)または%APPDATA%\Claude\claude_desktop_config.json(Windows)を編集。"mcpServers": { "roxy-astrology": { "type": "http", "url": "https://roxyapi.com/mcp/astrology", "headers": { "X-API-Key": "<key>" } } } を追加。Claudeを再起動。公開したいドメインごとに繰り返します。 |
| ノーコードプラットフォーム(n8n、Make、Zapier、Lovable、Bubble、Wix) | https://roxyapi.com/docs/integrations/{platform}を参照。プラットフォームがサポートする場合はMCPファーストの統合。 |
一般的なタスク(各行1つ)
すべてのパスのベースURL:https://roxyapi.com/api/v2。認証:X-API-Key: <key>。
SDKメソッド名は、OpenAPIの
operationIdを介してRESTを完全にミラーリングします。TS / PHP:roxy.{domain}.{operationId}/$roxy->{domain}->{operationId}(キャメルケース)。TSは{ data, error }を返します。PHPは型付けされたオブジェクトを返し、失敗時はRoxyApiExceptionをスローします。Python:roxy.{domain}.{operation_id}(スネークケース)。C#(.NET)はoperationIdベースではなくパスフルエント方式:roxy.{Domain}.{Resource}.GetAsync()または.PostAsync(new() { ... })(PascalCaseでURLをミラーリング、パスパラメータはroxy.Astrology.Horoscope["aries"].Dailyのようなインデクサ)、失敗時はRoxyErrorをスロー(e.Codeでスイッチ)。GoはoperationIdをPascalCaseでミラーリング:roxy.{Domain}.{Method}(ctx, ...)は(*XxxResponse, error)を返し、4xx/5xxは*RoxyError(.Codeでスイッチ)。例:roxy.astrology.getDailyHoroscope({ path: { sign: 'aries' } })、roxy.vedicAstrology.generateBirthChart({ body: { date, time, latitude, longitude, timezone } })、roxy.numerology.calculateLifePath({ body: { year, month, day } })、roxy.angelNumbers.analyzeNumberSequence({ query: { number: '1111' } })。完全なマッピングは各SDKパッケージ内にAGENTS.mdとして同梱されています(上記「パスの選択」でリンク)。
- デイリーホロスコープ:
GET /astrology/horoscope/{sign}/daily(signはパス、クエリではありません。小文字)。期間セグメントはdaily | weekly | monthlyのいずれか(yearlyはありません)。共有コア:{ sign, overview, love, career, health, finance, compatibleSigns }。Dailyは{ date, advice, luckyNumber, luckyColor, activeTransits, moonSign, moonPhase, energyRating }を追加。Weeklyは{ week, advice, luckyNumbers[], luckyDays[] }(複数形に注意)を返します。Monthlyは{ month, luckyNumbers[], luckyColor, weekByWeek[], keyDates[] }(トップレベルのadviceはありません)を返します。 - 西洋出生図:
POST /astrology/natal-chart、トップレベルに{ date, time, latitude, longitude, timezone }。timezoneは必須。レスポンスは{ planets[], houses[], aspects[] }(フラットな配列)。 - ヴェーダクンドリ:
POST /vedic-astrology/birth-chart、同じボディ。Lahiriayanamsaはサーバーサイドで適用。レスポンスは、planets[]ではなく、星座名をキーとするHOUSE-MAP:{ aries: { rashi, signs: [...] }, taurus: {...}, ..., pisces: {...}, meta, houses, combustion, planetaryWar, interpretations }。12の星座キーを反復処理して惑星の配置を取得します。 - パンチャンガ:
POST /vedic-astrology/panchang/detailed、{ date, latitude, longitude }。timeフィールドはありません。 - クンダリマッチング:
POST /vedic-astrology/compatibility(Guna Milan 36ポイントAshtakoota)。ボディは両方をラップ:{ person1: { date, time, latitude, longitude, timezone? }, person2: { ... } }。レスポンス:{ total, maxScore: 36, percentage, isCompatible, recommendation, doshas[], breakdown: [{ category, maxScore, score, description, person1, person2 }] }。8つのブレイクダウンカテゴリ(Koots):Varna、Vashya、Tara、Yoni、Grahamaitri、Gana、Bhakoot、Nadi。 - ヴェーダダシャ(現在のMahadasha + Antardasha):
POST /vedic-astrology/dasha/current、{ date, time, latitude, longitude, timezone? }。完全な120年VimshottariタイムラインにはPOST /vedic-astrology/dasha/majorを使用。Mahadasha内のサブ期間にはPOST /vedic-astrology/dasha/sub/{mahadasha}(パスは小文字の惑星名、例:venus)。 - ドーシャ:
POST /vedic-astrology/dosha/manglik、/kalsarpa、/sadhesati。ボディはクンドリと同じ。レスポンスは{ present: boolean, severity, description, exceptions, remedies }を保持。 - 数秘術ライフパス:
POST /numerology/life-path、{ year, month, day }の整数。birthDate文字列ではありません。 - 数秘術フルチャート:
POST /numerology/chart、{ fullName, year, month, day }。fullNameは出生証明書上の名前。レスポンスの数値はネストされています:coreNumbers.{ lifePath, expression, soulUrge, personality, birthDay, maturity }、それぞれが{ number, calculation, type, hasKarmicDebt, meaning }を保持。さらにトップレベルに{ profile, additionalInsights, birthDayProfile, maturityStatus, luckyAssociations, summary }。 - タロットドロー:
POST /tarot/draw、{ count: 1..78 }。オプションでseed、allowReversals、allowDuplicates。レスポンスは{ cards: [...] }(フラットな配列)。スプレッド({ positions: [{ card, ... }] }を返す)とは異なります。 - スリーカードスプレッド:
POST /tarot/spreads/three-card、オプションで{ question?, seed? }。ポジションラベル:Past、Present、Future。レスポンスは{ positions: [{ card, ... }] }であり、cards[]ではありません。各cardはDrawnCard:{ id, name, arcana, suit, number, position, reversed: boolean, keywords[], meaning: string, imageUrl }。reversed(isReversedではない)とmeaningは単一の文字列(方向は既に適用済み)に注意。同じボディ形状が/tarot/spreads/celtic-cross(10ポジション:Present Situation、Challenge、Distant Past、Near Future、Above、Below、Advice、External Influences、Hopes and Fears、Final Outcome)、/tarot/spreads/love(5ポジション)、/tarot/spreads/career(5ポジション)にも適用されます。カスタムスプレッドは/tarot/spreads/customで、必須のpositions配列を追加します。 - ヒューマンデザインボディグラフ:
POST /human-design/bodygraph、{ date, time, timezone }— 座標は不要(HDは出生瞬間を使用し、観測者の位置は使用しないため、Locationステップは不要)。1回の呼び出しで{ type, strategy, authority, profile, definition, incarnationCross, centers[9], channels[], gates[26] }を返します。タイプのみのクイズエントリ:POST /human-design/type。2人用相性:POST /human-design/connection、{ personA, personB }(各{ date, time, timezone })。 - 予測:
POST /forecast/transits(西洋占星術のトランジットから出生図へのアスペクト、イングレス、レトログレードステーション)およびPOST /forecast/timeline(西洋占星術のトランジット、ヴェーダダシャの境界、バイオリズムの臨界日をクロスドメインで統合)は、どちらも{ birthData: { date, time, timezone }, startDate?, endDate? }を受け付けます — 最大90日間の範囲、イベントはsignificanceでランク付け。年間バースデーチャート:POST /forecast/solar-return、{ date, time, year, latitude, longitude, timezone }(座標が必要なため、最初にLocationを呼び出してください)。 - 易経キャスト:
GET /iching/cast(ランダム)またはPOST /iching/daily/cast(シード付きデイリー)。レスポンスは{ hexagram, lines, changingLinePositions, resultingHexagram }、各hexagramは{ number (1-64), symbol, chinese, english, pinyin, judgment, image, interpretation, changingLines }を保持。六芒星の詳細:GET /iching/hexagrams/{number}、numberは整数1..64。 - バイオリズムデイリー:
POST /biorhythm/daily、{ birthDate, date?, seed? }。予測(30-90日間のウィンドウ):POST /biorhythm/forecast、{ birthDate, startDate?, endDate? }。相性:POST /biorhythm/compatibility、{ person1: { birthDate }, person2: { birthDate }, targetDate? }— 各人物のフラットなbirthDate、時間や座標は不要。 - クリスタル:
GET /crystals/zodiac/{sign}(星座マッチ)、GET /crystals/chakra/{chakra}(チャクラは大文字小文字を区別せず、スペース区切り:Root、Sacral、Solar PlexusはURLエンコードでSolar%20Plexus、Heart、Throat、Third EyeはURLエンコードでThird%20Eye、Crown— ケバブケースのthird-eyeは検証に失敗します)、GET /crystals/birthstone/{month}(月は整数1..12)、GET /crystals/search?q=(フリーテキスト)。 - エンジェルナンバールックアップ:
GET /angel-numbers/lookup?number=1111。任意の正の整数で機能します(数字根によるフォールバック)。 - 夢のシンボル:
GET /dreams/symbols/{slug}(ケバブケースのスラッグ、例:flying、water、snake、falling、house)。