Documentation

API Documentation

Learn how to integrate with the Tracverse API. This guide covers authentication, rate limits, and common use cases.

Getting Started

  1. Create a Developer Account - Sign in with your Tracverse account and complete the developer registration.
  2. Create an Application - Each application gets its own set of API keys and usage tracking.
  3. Generate an API Key - Create a production or test key. Save the secret key securely - it's only shown once.
  4. Make API Requests - Include your API key in the X-API-Key header.

Authentication

API Key Authentication
All API requests must include your API key in the request header.

Include your API key in the X-API-Key header:

curl -X GET "https://api.tracverse.com/api/v1/assets" \
  -H "X-API-Key: sk_live_your_api_key_here" \
  -H "Content-Type: application/json"
Production

Keys prefixed with sk_live_ for production use.

Test

Keys prefixed with sk_test_ for development.

Rate Limits

Rate Limit Tiers
Rate limits are applied per API key to ensure fair usage.
TierRequests/MinuteRequests/DayMonthly Quota
Free101,00010,000
Starter6010,000100,000
Pro300100,0001,000,000
Enterprise1,0001,000,00010,000,000

When rate limited, the API returns a 429 status code with a Retry-After header.

Code Examples

# List all assets
curl -X GET "https://api.tracverse.com/api/v1/assets" \
  -H "X-API-Key: sk_live_your_key" \
  -H "Content-Type: application/json"

# Get a specific asset by UAL
curl -X GET "https://api.tracverse.com/api/v1/assets/did:dkg:base:84532/0x123..." \
  -H "X-API-Key: sk_live_your_key"

# Create a new asset
curl -X POST "https://api.tracverse.com/api/v1/assets" \
  -H "X-API-Key: sk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"content": {"title": "My Asset", "data": {...}}}'

Error Handling

Error Codes
Common error codes and their meanings.
401

Unauthorized

Invalid or missing API key.

403

Forbidden

The API key doesn't have permission for this action.

404

Not Found

The requested resource doesn't exist.

429

Too Many Requests

Rate limit exceeded. Check the Retry-After header.

500

Internal Server Error

Something went wrong on our end. Please try again.