Skip to content
racks
Get started
Overview

API Reference

Libraries

TypeScript
0.1.0
npm install racks.cash
Read Docs

API Overview

Meta

API discovery and documentation

OpenAPI specification (this document)
GET/api/meta/openapi
Machine-readable API catalog (JSON)
GET/api/meta/racks-api

V1

Global XP leaderboard

Global XP leaderboard
GET/api/v1/leaderboard

V1Me

Authenticated user's own profile and keys

Current user profile
GET/api/v1/me
Earned badges for the token owner
GET/api/v1/me/badges
Circle memberships for the token owner
GET/api/v1/me/circles

V1Circles

Circle-scoped data (members, quests, leaderboard)

Circle profile and summary stats
GET/api/v1/circles/{id}
Members of a circle
GET/api/v1/circles/{id}/members
XP leaderboard for a circle
GET/api/v1/circles/{id}/leaderboard

V1CirclesQuests

Circle-scoped data (members, quests, leaderboard)

Quests for a circle
GET/api/v1/circles/{id}/quests
Create a quest in a circle
POST/api/v1/circles/{id}/quests

V1CirclesPosts

Circle-scoped data (members, quests, leaderboard)

Recent posts in a circle
GET/api/v1/circles/{id}/posts
Create a post in a circle
POST/api/v1/circles/{id}/posts

V1CirclesSocial

Social account connections and cross-posting via Zernio

Connected social accounts for a circle
GET/api/v1/circles/{id}/social/accounts
Publish to connected social accounts
POST/api/v1/circles/{id}/social/publish

User

UserAPI Keys

Authenticated user's own profile and keys

List your API keys
GET/api/user/api-keys
Create a new API key
POST/api/user/api-keys
Revoke an API key
DELETE/api/user/api-keys/{id}

Circles

CirclesAPI Keys

Circle-scoped data (members, quests, leaderboard)

List API keys for a circle
GET/api/circles/{id}/api-keys
Create a circle API key
POST/api/circles/{id}/api-keys
Revoke a circle API key
DELETE/api/circles/{id}/api-keys/{keyId}