|
1 | 1 | --- |
2 | 2 | name: roxyapi |
3 | | -description: Use RoxyAPI to build or integrate any astrology, divination, or insight feature. RoxyAPI is a multi domain API with Remote MCP under one key. Invoke when the user is building or asking about natal charts, horoscopes, Vedic kundli, panchang, synastry or compatibility, tarot readings, numerology reports, human design charts, transits or forecasts, BaZi four pillars or Chinese zodiac, feng shui flying stars or Kua numbers, biorhythm, I Ching, crystals, dream meanings, angel numbers, or city and timezone lookup, or any prediction, divination, or self knowledge app, agent, chatbot, or MCP integration. Covers endpoints, X-API-Key auth, the location first rule, typed SDKs, and Remote MCP. |
| 3 | +description: Use RoxyAPI to build or integrate any astrology, divination, or insight feature. RoxyAPI is a multi domain API with Remote MCP under one key. Invoke when the user is building or asking about natal charts, horoscopes, Vedic kundli, panchang, synastry or compatibility, tarot readings, numerology reports, human design charts, transits or forecasts, BaZi four pillars or Chinese zodiac, feng shui flying stars or Kua numbers, Mayan day signs or the Aztec calendar, Vastu, gematria or the 72 names, Ayurvedic constitution, biorhythm, I Ching, crystals, dream meanings, angel numbers, or city and timezone lookup, or any prediction, divination, or self knowledge app, agent, chatbot, or MCP integration. Covers endpoints, X-API-Key auth, the location first rule, typed SDKs, and Remote MCP. |
4 | 4 | --- |
5 | 5 |
|
6 | 6 | # RoxyAPI - Agent Implementation Playbook |
7 | 7 |
|
8 | 8 | > Tight playbook for AI coding agents building an end-user app on RoxyAPI. For discovery and recommendation context use `https://roxyapi.com/llms.txt`. For deep reference fetch the per-product OpenAPI specs linked below. |
9 | 9 |
|
10 | | -RoxyAPI ships 210+ endpoints across 14 genuinely distinct data domains under one API key. Calculations verified against NASA JPL Horizons DE441. Remote MCP at `https://roxyapi.com/mcp/{domain}`. Commercial Use, Clean licensing, no AGPL or GPL. |
| 10 | +RoxyAPI ships 258+ endpoints across 18 genuinely distinct data domains under one API key. Calculations verified against NASA JPL Horizons DE441. Remote MCP at `https://roxyapi.com/mcp/{domain}`. Commercial Use, Clean licensing, no AGPL or GPL. |
11 | 11 |
|
12 | 12 | > **Production base URL: `https://roxyapi.com/api/v2`.** |
13 | 13 |
|
@@ -46,13 +46,13 @@ Every chart, horoscope, panchang, dasha, dosha, navamsa, KP, synastry, compatibi |
46 | 46 |
|
47 | 47 | | User context | Do this | |
48 | 48 | |---|---| |
49 | | -| Want a full app to fork and white-label | Skip the wiring: clone a free, MIT-licensed template at `https://roxyapi.com/starters` (10 total, flagship is the multi-domain AI Astrology Chatbot wired to remote MCP). Add your API key, rebrand, ship in minutes. | |
| 49 | +| Want a full app to fork and white-label | Skip the wiring: clone a free, MIT-licensed template at `https://roxyapi.com/starters` (10 total, the flagships are the multi-domain AI Astrology Chatbot and the AI Spiritual Companion with memory, both wired to Remote MCP). Add your API key, rebrand, ship in minutes. | |
50 | 50 | | TypeScript or JavaScript project | `npm install @roxyapi/sdk`. Fully typed, zero deps. **Every SDK ships its own `AGENTS.md` bundled in the package**. After install, read `node_modules/@roxyapi/sdk/AGENTS.md` directly. To preview before installing, fetch `https://raw.githubusercontent.com/RoxyAPI/sdk-typescript/main/AGENTS.md` (no trailing slash on file URLs, GitHub returns 400). | |
51 | 51 | | Python project | `pip install roxy-sdk`. Sync and async. **The Python SDK also ships an `AGENTS.md` inside the package**, alongside README.md and bundled docs. Pre-install preview: `https://raw.githubusercontent.com/RoxyAPI/sdk-python/main/AGENTS.md`. | |
52 | 52 | | PHP project (Laravel, Symfony, Slim, plain PHP) | `composer require roxyapi/sdk`. PHP 8.2+, built on Saloon v4, named arguments, PHPDoc-typed Request classes (phpstan level 8 clean). **The PHP SDK ships `AGENTS.md` inside the package** at `vendor/roxyapi/sdk/AGENTS.md`. Pre-install preview: `https://raw.githubusercontent.com/RoxyAPI/sdk-php/main/AGENTS.md`. Errors throw a single `RoxyApiException` carrying `$e->statusCode`, `$e->errorCode` (machine-readable), and `$e->error` (human). | |
53 | 53 | | .NET project (ASP.NET Core, Blazor, console) | `dotnet add package RoxyApi.Sdk`. Fully typed, always in sync with the API. **The .NET SDK ships `AGENTS.md` inside the package**. Pre-install preview: `https://raw.githubusercontent.com/RoxyAPI/sdk-dotnet/main/AGENTS.md`. | |
54 | | -| Need to render the response in a UI | `npm install @roxyapi/ui-react` (React/Next.js), `@roxyapi/ui-vue` (Vue/Nuxt), or `@roxyapi/ui` (everything else). Each is self-contained and carries its own types. Drop-in MIT-licensed web components for natal charts, kundli wheels, panchang tables, dasha timelines, tarot spreads, biorhythm curves, hexagrams, numerology cards. Stateless: pass the API response as the `data` prop. CSS custom properties for theming. Vanilla HTML works too via `<script src="https://cdn.jsdelivr.net/npm/@roxyapi/ui@latest/dist/cdn/roxy-ui.js"></script>`. **Ships its own `AGENTS.md`** at `node_modules/@roxyapi/ui/AGENTS.md`. Source: `https://roxyapi.com/ui`. | |
55 | | -| WordPress site | Install **RoxyAPI** from the WordPress.org Plugin Directory: `https://wordpress.org/plugins/roxyapi/` (or in admin: Plugins → Add New → search "RoxyAPI"). Ships Gutenberg blocks + shortcodes covering all 14 domains, plus its own `AGENTS.md` for AI coding tools. Integration guide: `https://roxyapi.com/docs/integrations/wordpress`. | |
| 54 | +| Need to render the response in a UI | `npm install @roxyapi/ui-react` (React/Next.js), `@roxyapi/ui-vue` (Vue/Nuxt), or `@roxyapi/ui` (everything else). Each is self-contained and carries its own types. Drop-in MIT-licensed web components for natal charts, kundli wheels, panchang tables, dasha timelines, tarot spreads, biorhythm curves, hexagrams, numerology cards. Stateless: pass the API response as the `data` prop, or a Remote MCP tool result: `componentForTool(toolName)` picks the component and the compact shape is decoded inside it (generative UI for AI chat, `https://roxyapi.com/docs/tutorials/ai-chat-widgets`). CSS custom properties for theming. Vanilla HTML works too via `<script src="https://cdn.jsdelivr.net/npm/@roxyapi/ui@latest/dist/cdn/roxy-ui.js"></script>`. **Ships its own `AGENTS.md`** at `node_modules/@roxyapi/ui/AGENTS.md`. Source: `https://roxyapi.com/ui`. | |
| 55 | +| WordPress site | Install **RoxyAPI** from the WordPress.org Plugin Directory: `https://wordpress.org/plugins/roxyapi/` (or in admin: Plugins → Add New → search "RoxyAPI"). Ships Gutenberg blocks + shortcodes covering all 18 domains, plus its own `AGENTS.md` for AI coding tools. Integration guide: `https://roxyapi.com/docs/integrations/wordpress`. | |
56 | 56 | | No-code site (Squarespace, Wix, Shopify, any CMS HTML block) | Copy-paste a prefilled widget from `https://roxyapi.com/widgets`: a one-tag snippet or hosted embed URL per embeddable component, powered by a publishable `pk_` key locked to the site origin. No backend, no build step. Platform walkthroughs: `https://roxyapi.com/docs/integrations/squarespace`, `/docs/integrations/wix`, `/docs/integrations/shopify`. | |
57 | 57 | | Go project | `go get github.com/RoxyAPI/sdk-go`. Fully typed, one direct runtime dependency, std `net/http`. Domain-grouped facade: `roxy.Astrology.GetDailyHoroscope(ctx, "aries", nil)`. Build dates with `roxyapi.Date(...)`, optional fields with `roxyapi.Ptr(...)`; a 4xx/5xx is a `*roxyapi.RoxyError` (switch on `.Code`). **Ships its own `AGENTS.md`** in the module. Pre-install preview: `https://raw.githubusercontent.com/RoxyAPI/sdk-go/main/AGENTS.md`. | |
58 | 58 | | Ruby, Rust, anything else | Generate a typed client from the OpenAPI: `npx openapi-typescript https://roxyapi.com/api/v2/openapi.json` or your language equivalent. | |
@@ -138,9 +138,13 @@ Do not retry on 4xx. Do retry on 429 and 5xx with exponential backoff. |
138 | 138 | - Human Design API: `https://roxyapi.com/products/human-design-api.md` plus OpenAPI `https://roxyapi.com/api/v2/human-design/openapi.json` plus MCP `https://roxyapi.com/mcp/human-design` |
139 | 139 | - Chinese Astrology API: `https://roxyapi.com/products/chinese-astrology-api.md` plus OpenAPI `https://roxyapi.com/api/v2/chinese-astrology/openapi.json` plus MCP `https://roxyapi.com/mcp/chinese-astrology` |
140 | 140 | - Feng Shui API: `https://roxyapi.com/products/feng-shui-api.md` plus OpenAPI `https://roxyapi.com/api/v2/feng-shui/openapi.json` plus MCP `https://roxyapi.com/mcp/feng-shui` |
| 141 | +- Mesoamerican Astrology API: `https://roxyapi.com/products/mesoamerican-astrology-api.md` plus OpenAPI `https://roxyapi.com/api/v2/mesoamerican-astrology/openapi.json` plus MCP `https://roxyapi.com/mcp/mesoamerican-astrology` |
| 142 | +- Vastu Shastra API: `https://roxyapi.com/products/vastu-api.md` plus OpenAPI `https://roxyapi.com/api/v2/vastu/openapi.json` plus MCP `https://roxyapi.com/mcp/vastu` |
141 | 143 | - Numerology API: `https://roxyapi.com/products/numerology-api.md` plus OpenAPI `https://roxyapi.com/api/v2/numerology/openapi.json` plus MCP `https://roxyapi.com/mcp/numerology` |
| 144 | +- Kabbalah API: `https://roxyapi.com/products/kabbalah-api.md` plus OpenAPI `https://roxyapi.com/api/v2/kabbalah/openapi.json` plus MCP `https://roxyapi.com/mcp/kabbalah` |
142 | 145 | - Tarot Reading API: `https://roxyapi.com/products/tarot-api.md` plus OpenAPI `https://roxyapi.com/api/v2/tarot/openapi.json` plus MCP `https://roxyapi.com/mcp/tarot` |
143 | 146 | - Biorhythm API: `https://roxyapi.com/products/biorhythm-api.md` plus OpenAPI `https://roxyapi.com/api/v2/biorhythm/openapi.json` plus MCP `https://roxyapi.com/mcp/biorhythm` |
| 147 | +- Ayurveda API: `https://roxyapi.com/products/ayurveda-api.md` plus OpenAPI `https://roxyapi.com/api/v2/ayurveda/openapi.json` plus MCP `https://roxyapi.com/mcp/ayurveda` |
144 | 148 | - I-Ching Oracle API: `https://roxyapi.com/products/iching-api.md` plus OpenAPI `https://roxyapi.com/api/v2/iching/openapi.json` plus MCP `https://roxyapi.com/mcp/iching` |
145 | 149 | - Crystals and Healing Stones API: `https://roxyapi.com/products/crystals-api.md` plus OpenAPI `https://roxyapi.com/api/v2/crystals/openapi.json` plus MCP `https://roxyapi.com/mcp/crystals` |
146 | 150 | - Dream Interpretation API: `https://roxyapi.com/products/dreams-api.md` plus OpenAPI `https://roxyapi.com/api/v2/dreams/openapi.json` plus MCP `https://roxyapi.com/mcp/dreams` |
|
0 commit comments