Authentication

API Key Authentication

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY
        Copy
      

Example Request

curl -X GET "https://api.zsignals.xyz/v1/market/trending" \
  -H "Authorization: Bearer sk_live_51H2fGbC4dEfGHiJkLmN8oPqR" \
  -H "Accept: application/json"
        Copy
      

Getting Your API Key

1. Subscribe: Get API access at zsignals.xyz/api_subscriptions/new
2. Choose Plan: Select monthly ($299) or annual ($1,999 - save 44%)
3. Complete Payment: Pay via Stripe (card) or Coinbase Commerce (crypto)
4. Sign In: Check your email for authentication link
5. Account Dashboard: Visit zsignals.xyz/account
6. Generate Key: Click "Generate New API Key" in the API Access section
7. Save Securely: Copy your key - you can create multiple keys for different environments

API Key Format

API keys are 64-character hexadecimal strings:

Example: a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456
        Copy
      

Authentication Errors

The API returns specific error codes for authentication issues:

Example Error Response

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The API key provided is invalid",
    "details": {
      "provided_key": "sk_live_invalid123",
      "help": "Please check your API key and try again"
    }
  }
}
        Copy
      

Rate Limiting

API subscriptions include generous rate limits for production applications:

Rate Limit Headers

Every API response includes rate limit information in the headers:

HTTP/2 200 OK
X-RateLimit-Limit-Month: 500000
X-RateLimit-Remaining-Month: 487234
X-RateLimit-Limit-Hour: 5000
X-RateLimit-Remaining-Hour: 4821
X-RateLimit-Reset-Month: 1730419200
X-RateLimit-Reset-Hour: 1729180800
        Copy
      

Security Best Practices

Using Environment Variables

Store your API key securely using environment variables:

# .env file
ZSIGNALS_API_KEY=sk_live_51H2fGbC4dEfGHiJkLmN8oPqR

# Load in bash
export ZSIGNALS_API_KEY="sk_live_51H2fGbC4dEfGHiJkLmN8oPqR"

# Use in curl
curl -H "Authorization: Bearer $ZSIGNALS_API_KEY" \
  https://api.zsignals.xyz/v1/market/trending
          Copy
        

// Install: npm install dotenv
require('dotenv').config();

const API_KEY = process.env.ZSIGNALS_API_KEY;

const response = await fetch('https://api.zsignals.xyz/v1/market/trending', {
  headers: {
    'Authorization': `Bearer ${API_KEY}`
  }
});
          Copy
        

# Install: pip install python-dotenv
from dotenv import load_dotenv
import os
import requests

load_dotenv()
API_KEY = os.getenv('ZSIGNALS_API_KEY')

response = requests.get(
    'https://api.zsignals.xyz/v1/market/trending',
    headers={'Authorization': f'Bearer {API_KEY}'}
)
          Copy
        

# Add to Gemfile: gem 'dotenv'
require 'dotenv/load'
require 'net/http'

api_key = ENV['ZSIGNALS_API_KEY']

uri = URI('https://api.zsignals.xyz/v1/market/trending')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Authorization'] = "Bearer #{api_key}"

response = http.request(request)
          Copy
        

API Key Management

Manage all your API keys from your account dashboard at zsignals.xyz/account

Account Dashboard Features

Your account page provides comprehensive API key management:

Creating Multiple API Keys

Generate separate keys for different environments or applications:

1. Visit your account at zsignals.xyz/account
2. Scroll to the "API Access" section
3. Click "Generate New API Key"
4. The system automatically names it with current timestamp
5. Copy your new key immediately (shown in full only once)

Revoking Keys

Immediately deactivate compromised or unused API keys:

1. Navigate to your API keys table at zsignals.xyz/account
2. Locate the key you want to revoke
3. Click the red "Revoke" button in the Actions column
4. Confirm the revocation (this cannot be undone)
5. The key is immediately deactivated and will return 401 errors