Quickstart

Your first API call in 60 seconds.

1. Get your API key

Pick a plan at roxyapi.com/pricing. The key lands in your inbox seconds after checkout. No account, no approval.

Want to explore first? The API Playground lets you browse every endpoint and see real request and response shapes. Paste your key to make live calls from the browser.

2. Call your first endpoint

Pick a language tab and paste.

curl -X POST https://roxyapi.com/api/v2/tarot/daily \
  -H "X-API-Key: $ROXY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

npm install @roxyapi/sdk

import { createRoxy } from '@roxyapi/sdk';

const roxy = createRoxy(process.env.ROXY_API_KEY!);

const { data } = await roxy.tarot.getDailyCard({ body: {} });
console.log(data.card.name);      // "The Star"
console.log(data.dailyMessage);   // concise daily guidance

pip install roxy-sdk

from roxy_sdk import create_roxy

roxy = create_roxy("your-api-key")

card = roxy.tarot.get_daily_card()
print(card["card"]["name"])       # "The Star"
print(card["dailyMessage"])

composer require roxyapi/sdk

<?php

use function RoxyAPI\Sdk\createRoxy;

$roxy = createRoxy(getenv('ROXY_API_KEY'));

$card = $roxy->tarot->getDailyCard();
echo $card['card']['name'];    // "The Star"
echo $card['dailyMessage'];

dotnet add package RoxyApi.Sdk

using RoxyApi;

var roxy = new RoxyClient(Environment.GetEnvironmentVariable("ROXY_API_KEY")!);

var card = await roxy.Tarot.Daily.PostAsync(new());
Console.WriteLine(card!.Card!.Name);    // "The Star"
Console.WriteLine(card.DailyMessage);   // concise daily guidance

claude mcp add-json --scope user roxy-tarot \
  '{"type":"http","url":"https://roxyapi.com/mcp/tarot","headers":{"X-API-Key":"YOUR_KEY"}}'

3. See the response

{
  "date": "2026-04-23",
  "card": {
    "name": "The Star",
    "arcana": "major",
    "keywords": ["Hope", "faith", "renewal"],
    "meaning": "A welcome reprieve after upheaval...",
    "imageUrl": "https://roxyapi.com/img/tarot/major/star.jpg"
  },
  "dailyMessage": "Your card for today: The Star..."
}

That is it. Every Roxy endpoint works the same way: send a request, get typed JSON back.

What to do next

• Ship production code. The SDK guide covers the typed TypeScript, Python, PHP, C#, and Go clients, error handling, and framework examples.
• Build with AI agents. The MCP guide covers the keyless docs server for coding agents (Claude Code, Cursor, Copilot) and the per-domain servers for runtime agents (ChatGPT, Claude Desktop, Gemini, n8n). One command per server, then the agent picks the right tool from natural language.
• Pick the right endpoint. Every domain guide lists the most-used endpoints in order, with copy-paste code per domain.
• Browse every endpoint. The API reference lets you call any of the 164+ endpoints live in the browser with your key.

Prefer to vibe-code?

If you are building in Cursor, Claude Code, Bolt, Lovable, or Next.js, paste one of our AI Prompts and the agent scaffolds a working app end to end. No endpoint-picking required.

Coding agent? Read AGENTS.md first

If you are an AI coding agent (Cursor, Codex, Windsurf, Aider, Claude Code, Gemini CLI), point yourself at AGENTS.md first. It is the tight 120-line execution playbook with Rule 0 (location first), all common-task body shapes, the error contract, and field gotchas. Built for blind agents to ship without crawling the full docs site.