Skip to main content

Getting Started

This guide walks you through the essential steps to start using the BigONE API in about 5 minutes.

Prerequisites​

Before you begin, you'll need:

  • A BigONE account with API access
  • Basic knowledge of HTTP and JSON
  • A programming language with HTTP client support (Python, Go, JavaScript, etc.)

Step 1: Create an API Key​

  1. Log in to your BigONE account
  2. Navigate to API Settings
  3. Click Create API Key
  4. Select the required permission scopes for your use case
  5. Save your API Secret immediately — it will only be shown once
Security First

Never share your API Secret. It grants full access to your account within the granted scopes.

See API Key Setup for detailed instructions.

Step 2: Generate a JWT Token​

All private API requests require a JWT token in the Authorization header.

Example: Generate Token (Python)​

import jwt
import time

API_KEY = 'your_api_key_here'
API_SECRET = 'your_api_secret_here'

# Generate nonce: current timestamp in nanoseconds
nonce = int(time.time() * 1e9)

# Create JWT payload
payload = {
    "type": "OpenAPIV2",
    "sub": API_KEY,
    "nonce": str(nonce),
}

# Sign the token
token = jwt.encode(payload, API_SECRET, algorithm="HS256")

See Authentication for code examples in Go and JavaScript.

Step 3: Make Your First Request​

Use the generated token to make an authenticated request:

# Public endpoint - no authentication required
curl "https://api.big.one/api/v3/asset_pairs" # Fetches all available Asset Pairs

# Private endpoint - requires authentication
curl "https://api.big.one/api/v3/viewer/accounts" \
     -H "Authorization: Bearer YOUR_JWT_TOKEN"

Step 4: Handle Responses​

All API responses follow this format:

{
  "code": 0,
  "data": { ... },
  "page_token": "abc123..."  // Only for paginated endpoints
}
  • code: 0 indicates success
  • Non-zero code indicates an error
  • See General Information for rate limits and error handling

Next Steps​