Documentation/API Reference

API Reference

The RealmKit API allows you to integrate realm functionality into your applications, build custom tools, and automate workflows. Most endpoints are public and free to use.

API Overview

RESTful API with JSON responses and comprehensive documentation

REST
Architectural style
JSON
Response format
HTTPS
Secure by default
v1
Current version
Base URL
https://api.realmkit.com/v1
Try API

API Features

Powerful capabilities designed for developers

RESTful Design

Clean, predictable REST API following industry standards

Intuitive endpoints
Standard HTTP methods
JSON responses
Clear error codes

Authentication

Multiple authentication methods for different use cases

API keys
OAuth 2.0
JWT tokens
Rate limiting

Real-time Data

Access to live realm data and statistics

Realm listings
Download counts
User statistics
Search functionality

Developer Friendly

Built for developers with comprehensive tooling

Interactive docs
SDKs available
Code examples
Postman collection

Quick Start

Get started with the RealmKit API in minutes

1. Make Your First Request

curl "https://api.realmkit.com/v1/realms?limit=5"
                    
# Or using JavaScript
fetch('https://api.realmkit.com/v1/realms?limit=5')
  .then(response => response.json())
  .then(data => console.log(data))

2. Authentication (Optional)

curl "https://api.realmkit.com/v1/realms" \
  -H "Authorization: Bearer your-api-key"

Most endpoints work without authentication.Learn about authentication →

Popular Endpoints

Most commonly used API endpoints

GET
/realms
Popular

List all available realms with filtering and pagination

GET
/realms/{slug}
Popular

Get detailed information about a specific realm

POST
/realms/{slug}/download

Record a download and get download URL

POST
/realms
Auth

Create a new realm (requires authentication)

GET
/collections

Get curated collections of realms

GET
/stats

Get platform statistics and metrics

Use Cases

What you can build with the RealmKit API

CLI Tools

Build custom command-line interfaces

Examples
Custom realm managers
Deployment scripts
Automation tools

Web Integrations

Integrate RealmKit into web applications

Examples
Realm browsers
Template galleries
Project generators

Analytics & Monitoring

Track usage and build dashboards

Examples
Download analytics
Usage dashboards
Trend analysis

CI/CD Integration

Automate deployment and testing workflows

Examples
Automated testing
Deployment pipelines
Quality checks

Official SDKs

Language-specific libraries for easier integration

JavaScript/TypeScript

Official SDK for Node.js and browsers

Official
Installation
npm install @realmkit/sdk
Features
TypeScript supportPromise-basedBrowser compatibleTree-shakeable

Python

Python library for server-side integrations

Official
Installation
pip install realmkit
Features
Async supportType hintsPytest integrationDjango/Flask helpers

Go

Go client library for high-performance applications

Official
Installation
go get github.com/realmkit/go-sdk
Features
Context supportStructured loggingConcurrent safeMinimal dependencies
Community SDKs
Community-maintained SDKs are available for additional languages. Check our awesome list for more options.

Rate Limits & Pricing

Fair usage limits and pricing information

Free Tier

100
requests/hour
  • • No authentication required
  • • All public endpoints
  • • Basic rate limiting

Authenticated

1,000
requests/hour
  • • Free API key required
  • • Higher rate limits
  • • Upload capabilities

Premium

5,000
requests/hour
  • • Premium subscription
  • • Highest rate limits
  • • Priority support