Authentication

curl -H "x-api-key: dx_sk_live_1234567890abcdefghijklmnopqrstuvwxyz" \
  https://api.1tx.fi/api/v1/instruments

curl -X POST "https://api.1tx.fi/api/v1/transactions/buy" \
  -H "Authorization: Bearer <your_jwt>" \
  -H "x-api-key: dx_sk_live_1234567890abcdefghijklmnopqrstuvwxyz" \
  -H "Content-Type: application/json" \
  -d '{
    "userAddress": "0x...",
    "instrumentId": "0x...",
    "amountUsdc": "1000"
  }'

const API_KEY = process.env['1TX_API_KEY'];

async function fetchInstruments() {
  const response = await fetch('https://api.1tx.fi/api/v1/instruments', {
    headers: {
      'x-api-key': API_KEY,
      'Content-Type': 'application/json',
    },
  });

  if (!response.ok) {
    throw new Error(`API error: ${response.status}`);
  }

  return response.json();
}

import os
import requests

API_KEY = os.environ['1TX_API_KEY']

def fetch_instruments():
    response = requests.get(
        'https://api.1tx.fi/api/v1/instruments',
        headers={
            'x-api-key': API_KEY,
            'Content-Type': 'application/json'
        }
    )
    response.raise_for_status()
    return response.json()

import { 1txClient } from '@1tx/sdk';

const client = new 1txClient({
  apiKey: process.env.1TX_API_KEY,
});

// SDK handles authentication automatically
const instruments = await client.instruments.list();

# Test key example
dx_sk_test_1234567890abcdefghijklmnopqrstuvwxyz

# Live key example
dx_sk_live_1234567890abcdefghijklmnopqrstuvwxyz

GET /api/v1/api-keys

const response = await fetch('https://api.1tx.fi/api/v1/api-keys', {
  headers: {
    'x-api-key': API_KEY,
  },
});

const { data } = await response.json();
// Returns list of all your keys with metadata

{
  "data": [
    {
      "id": "key_123abc",
      "name": "production-app",
      "prefix": "dx_sk_live_",
      "lastUsed": "2024-01-15T14:30:00Z",
      "createdAt": "2024-01-01T10:00:00Z",
      "expiresAt": null,
      "status": "active"
    }
  ]
}

PATCH /api/v1/api-keys/:id

const response = await fetch('https://api.1tx.fi/api/v1/api-keys/key_123abc', {
  method: 'PATCH',
  headers: {
    'x-api-key': API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'new-name',
    status: 'inactive'
  }),
});

DELETE /api/v1/api-keys/:id

const response = await fetch('https://api.1tx.fi/api/v1/api-keys/key_123abc', {
  method: 'DELETE',
  headers: {
    'x-api-key': API_KEY,
  },
});

POST /api/v1/api-keys

const response = await fetch('https://api.1tx.fi/api/v1/api-keys', {
  method: 'POST',
  headers: {
    'x-api-key': API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    name: 'staging-environment',
    expiresAt: '2024-12-31T23:59:59Z', // Optional
  }),
});

const { data } = await response.json();
console.log('New API key:', data.key);

{
  "data": {
    "id": "key_456def",
    "name": "staging-environment",
    "key": "dx_sk_live_1234567890abcdefghijklmnopqrstuvwxyz",
    "prefix": "dx_sk_live_",
    "createdAt": "2024-01-15T15:00:00Z",
    "expiresAt": "2024-12-31T23:59:59Z"
  }
}

// Response headers
{
  "X-RateLimit-Limit": "10000",
  "X-RateLimit-Remaining": "9850",
  "X-RateLimit-Reset": "1642261200"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key is required. Include it in the x-api-key header.",
    "details": {
      "timestamp": "2024-01-15T14:30:00Z"
    }
  }
}

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or has been revoked.",
    "details": {
      "timestamp": "2024-01-15T14:30:00Z"
    }
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Your API key does not have permission to access this resource.",
    "details": {
      "timestamp": "2024-01-15T14:30:00Z"
    }
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "You have exceeded your API rate limit.",
    "details": {
      "limit": 10000,
      "resetAt": "2024-01-15T15:00:00Z"
    }
  }
}