Developer API
api.rareas.com - OpenAPI 3.1
Access catalog data, manage collections programmatically, subscribe to real-time events, and integrate rarity intelligence into your applications.
Getting Started
Follow these steps to integrate with the RareAS platform.
API Documentation
Explore the available API surfaces for building integrations.
REST API Reference
Full REST resource reference with request / response examples for every endpoint.
GraphQL Explorer
Interactive GraphQL schema explorer with inline documentation and query builder.
Webhooks Guide
Subscribe to real-time events for catalog changes, collection updates, and more.
Developer console requires sign in
Public API documentation is available here. Sign in to register clients, issue keys, manage webhooks, and view usage for your RareAS account.
Rate limits by tier
API rate limits are enforced per client. Upgrade your plan or contact support for higher limits.
Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in every API response. Implement exponential backoff when you receive a 429 status.
Code Examples
Quick-start snippets for common API operations. Replace YOUR_API_KEY with a real key.
curl -X GET "https://www.rareas.com/api/v1/catalog/items/" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json"API Sandbox
Try a live request against the catalog API. The endpoint /api/v1/items/{id}/rarity returns rarity data for any cataloged item.
{
"id": "earthbound-snes-cib",
"title": "EarthBound",
"platform": "SNES",
"rarityScore": 87,
"rarityTier": "Rare As Mythic"
}Security Best Practices
- Store API keys in environment variables or a secrets manager. Never commit them to source control.
- Use the minimum required scopes for each API key.
- Verify webhook signatures using your client secret before processing payloads.
- Rotate API keys periodically and revoke any compromised keys immediately.
- Implement exponential backoff for rate-limited requests (HTTP 429).