RoxyAPI

Menu

Quick StartAPI PlaygroundSDKMCP SetupFree StartersPricing
  1. Docs
  3. Build With Roxy
  5. Cursor

Cursor

Cursor is the most popular AI code editor. RoxyAPI works with Cursor through MCP servers and docs indexing. Add RoxyAPI docs and your AI builds with real API knowledge instead of guessing.

Add RoxyAPI docs to Cursor

Give Cursor full knowledge of every RoxyAPI endpoint, parameter, and response shape.

  1. Open Cursor Settings (gear icon or Cmd+,)
  2. Go to Features and scroll to Docs
  3. Click Add new doc
  4. Enter the URL: https://roxyapi.com/llms.txt
  5. Name it RoxyAPI

Now use @Docs RoxyAPI in any prompt to give Cursor full API context. The docs cover all 8 domains, 120+ endpoints, and every request/response field.

Add RoxyAPI as an MCP server

MCP lets Cursor call RoxyAPI tools directly. The AI discovers available endpoints and calls them as needed.

Option A: Cursor Settings UI

  1. Open Cursor Settings and go to MCP
  2. Click Add MCP Server
  3. Set Type to HTTP
  4. URL: https://mcp.roxyapi.com/mcp
  5. Add header: X-API-Key: YOUR_KEY

Option B: Project config file

Create .cursor/mcp.json in your project root:

{
  "mcpServers": {
    "roxyapi": {
      "type": "http",
      "url": "https://mcp.roxyapi.com/mcp",
      "headers": {
        "X-API-Key": "${ROXY_API_KEY}"
      }
    }
  }
}

Set ROXY_API_KEY in your environment or .env file. Cursor reads the variable at runtime.

Add project rules

Create .cursor/rules/roxyapi.md so Cursor follows RoxyAPI conventions in every prompt:

When using RoxyAPI:
- Base URL: https://roxyapi.com/api/v2
- Auth: X-API-Key header from env ROXY_API_KEY
- Never expose the API key in client-side code
- Use the @roxyapi/sdk for typed calls: npm install @roxyapi/sdk
- Reference docs: @Docs RoxyAPI
- All endpoints return clean JSON, errors return { error, code }
- Multi-language support: add ?lang=tr|de|es|hi|pt|fr|ru

Example prompts

Paste these into Cursor chat or inline edit. Replace the domain with whatever you are building.

Using @Docs RoxyAPI, build a birth chart component that takes a date, time, and city
Add a tarot daily card to my homepage using RoxyAPI @Docs RoxyAPI
Create a numerology calculator page with Life Path, Expression, and Soul Urge numbers @Docs RoxyAPI
Build a dream symbol search with autocomplete using the Dreams API @Docs RoxyAPI
Using @Docs RoxyAPI, add a Vedic astrology kundli page with planet positions and dasha periods

TypeScript types

Generate types from any RoxyAPI OpenAPI spec:

npx openapi-typescript https://roxyapi.com/api/v2/astrology/openapi.json -o src/api/astrology.ts

Available specs: astrology, vedic-astrology, tarot, numerology, iching, dreams, crystals, angel-numbers.

Or install the SDK for pre-built types across all domains:

npm install @roxyapi/sdk

What is next