Skip to Content
DocsOverview

Atlas API Overview

Atlas exposes REST APIs for explorer reads, on-demand event decoding, and SEP-0048 schema registry operations. Most endpoints live under /v1.

Base URL

EnvironmentURL
Localhttp://localhost:8080
ProductionConfigure via ATLAS_API_URL

The Naralabs website proxies browser reads through /api/atlas/* (BFF). Integrations should call Atlas directly with an API key.

Credentials summary

CredentialPrefixUse case
API keynl_api_Decode API + programmatic explore reads
Publish tokennl_live_Schema publishing (POST /v1/schemas)

See API Credentials and Quickstart.

Common parameters

ParameterDescription
networkStellar network (testnet, mainnet, futurenet)
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

Decoder

MethodPathAuthDescription
POST/v1/decodeAPI keyDecode one raw Soroban event
POST/v1/decode/batchAPI keyBatch decode (max 50)

See Decode API.

Explore (read)

MethodPathAuthDescription
GET/healthNoneService health
GET/v1/statsAPI key recommendedNetwork statistics
GET/v1/homeAPI key recommendedHomepage aggregate payload
GET/v1/eventsAPI key recommendedPaginated events list
GET/v1/events/{id}API key recommendedEvent detail
GET/v1/contractsAPI key recommendedPaginated contracts list
GET/v1/contracts/{id}API key recommendedContract detail
GET/v1/contracts/{id}/eventsAPI key recommendedContract events (paginated)

Schema registry (SEP-0048)

MethodPathAuthDescription
POST/v1/schemasPublish tokenPublish new schema version
GET/v1/schemasNoneList schemas (limit, offset, search)
GET/v1/schemas/{contract_id}NoneLatest schema per event on a contract
GET/v1/schemas/{contract_id}/{event_name}NoneGet schema (?version= optional)
GET/v1/schemas/contractsNoneContract-level schema bundles
GET/v1/schemas/summaryNoneRegistry aggregate stats

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

Events (GET /v1/events)

ParameterDescription
networkRequired. testnet, mainnet, …
page, page_sizePagination (max page_size 100)
searchEvent ID, contract ID, txn hash, payload
event_typeFilter by type symbol
decode_statusdecoded or raw

GET /v1/events/{id}?network= returns full topics, value JSON, XDR, and decode metadata.

Contracts (GET /v1/contracts)

ParameterDescription
networkRequired
page, page_sizePagination
searchContract ID
schema_statusdecoded or raw_only

GET /v1/contracts/{id}: summary and schema info.
GET /v1/contracts/{id}/events: paginated events for one contract (same filters as /v1/events).

OpenAPI / Scalar

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

Last updated on
Schema RegistryQuickstart