Skip to Content
DocsAtlas APIOverview

Atlas API Overview

Atlas exposes a read-only REST API for explorer data. All endpoints live under /v1 and require a network query parameter.

Base URL

EnvironmentURL
Localhttp://localhost:8080
ProductionConfigure via ATLAS_API_URL

The web app proxies browser requests through /api/atlas/* (BFF).

Common parameters

ParameterDescription
networkStellar network (testnet, mainnet)
pagePage number (1-based, default 1)
page_sizeItems per page (default 20, max 100)

Paginated response

List endpoints return:

{ "items": [], "total": 0, "page": 1, "page_size": 20 }

Endpoints

Explore (read)

MethodPathDescription
GET/healthService health
GET/v1/statsNetwork statistics
GET/v1/homeHomepage aggregate payload
GET/v1/eventsPaginated events list
GET/v1/events/{id}Event detail
GET/v1/contractsPaginated contracts list
GET/v1/contracts/{id}Contract detail
GET/v1/contracts/{id}/eventsContract events (paginated)

Schema registry (SEP-0048)

MethodPathDescription
POST/v1/schemasPublish new schema version
GET/v1/schemasList schemas (limit, offset, search)
GET/v1/schemas/{contract_id}Latest schema per event on a contract
GET/v1/schemas/{contract_id}/{event_name}Get schema (?version= optional)

Registry list pagination uses limit / offset, not page / page_size.

Auth

MethodPathDescription
POST/v1/auth/registerRegister account
POST/v1/auth/loginLogin
POST/v1/auth/verify-emailVerify email token
POST/v1/auth/resend-verificationResend verification
GET/v1/auth/meCurrent user (Bearer JWT)

OpenAPI / Scalar

In development, Atlas serves interactive API docs at /docs on the Atlas server (Scalar UI).

Authentication

Explore and schema registry read/publish endpoints do not require authentication today. Auth endpoints (/v1/auth/*) issue and validate JWT sessions for the web app login flow; GET /v1/auth/me requires a Bearer token.

Last updated on