Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nexus.gerowallet.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

The Gero Nexus API provides comprehensive access to Cardano blockchain data through simple RESTful endpoints.

Base URL

All API requests should be made to:
https://nexus-dev.gerowallet.io/v1

Authentication

All requests must include a valid JWT access token in the Authorization header:
Authorization: Bearer your-access-token
See our Authentication guide for details on how to obtain tokens.

Response Format

All responses are returned in JSON format with consistent structure:

Success Response

{
  "data": {
    // Response data here
  },
  "status": "success"
}

Error Response

{
  "error": "Error Type",
  "message": "Human-readable error message",
  "code": "ERROR_CODE",
  "status": "error"
}

Available Endpoints

Browse our comprehensive API endpoints organized by category:

Cardano Blocks

Query block data, headers, confirmations, and block information

Transactions

Get transaction details, UTXOs, metadata, and transaction history

Addresses

Look up address balances, transactions, assets, and UTXO sets

Accounts

Retrieve stake account information, rewards, and delegation history

Assets

Query native tokens, NFTs, policy IDs, and asset metadata

Epochs

Get epoch data, protocol parameters, and network information

Stake Pools

Access pool information, performance metrics, and delegator lists

Authentication

User authentication, device auth, and JWT token management

Provider Health

Check API status, blockchain sync, and service health

IPFS

Resolve IPFS content and metadata from CIDs

Blockchain Sync

Monitor synchronization status and blockchain height
Mintlify will auto-generate detailed pages for each endpoint from our OpenAPI specification once deployed.

Interactive API Playground

Test all endpoints in real-time with your API key:

🎮 Try the API Playground

Interactive testing environment with live responses, code generation in multiple languages, and request/response examples.

Rate Limits

Rate limits vary by plan:
PlanRequests/DayRequests/Second
Free10,0005
Starter100,00020
Pro1,000,000100
EnterpriseCustomCustom
See Rate Limits for details.

Pagination

Endpoints that return lists support pagination: Query Parameters:
  • page - Page number (default: 1)
  • count - Items per page (default: 20, max: 100)
Response Headers:
X-Total-Count: 1234
X-Page: 1
X-Page-Size: 20
X-Total-Pages: 62
See Pagination for examples.

Versioning

The API is versioned via the URL path (/v1). We maintain backward compatibility within major versions. Current version: v1

Need Help?

Quick Start

Get started in 5 minutes

API Playground

Test endpoints interactively