Authentication

• Socket.IO sends the token once in the connection handshake (auth: { token }).
• HTTP sends the token on every request in the Authorization header, as the raw token with no Bearer prefix.

​

Authentication Flow

1. Obtain your API credentials (API URL and Auth Token)
2. Provide the token: in the Socket.IO handshake, or in the HTTP Authorization header
3. The server validates your token
4. If valid, you can start making API requests

​

Connecting with Credentials

import { io } from "socket.io-client";

const socket = io(CHAINWORKS_API_URL, {
  transports: ["websocket"],
  auth: {
    token: CHAINWORKS_API_AUTH_TOKEN,
  },
});

import socketio

sio = socketio.Client()

sio.connect(
    CHAINWORKS_API_URL,
    transports=["websocket"],
    auth={"token": CHAINWORKS_API_AUTH_TOKEN}
)

const res = await fetch(`${CHAINWORKS_API_URL}/svm/token/meta`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: CHAINWORKS_API_AUTH_TOKEN,
  },
  body: JSON.stringify({ chain: "sol", token: "..." }),
});

import requests

res = requests.post(
    f"{CHAINWORKS_API_URL}/svm/token/meta",
    headers={"Authorization": CHAINWORKS_API_AUTH_TOKEN},
    json={"chain": "sol", "token": "..."},
)

​

Environment Variables

CHAINWORKS_API_URL=https://api.chainworks.co
CHAINWORKS_API_AUTH_TOKEN=your-secret-token

const socket = io(process.env.CHAINWORKS_API_URL!, {
  transports: ["websocket"],
  auth: {
    token: process.env.CHAINWORKS_API_AUTH_TOKEN!,
  },
});

const res = await fetch(`${process.env.CHAINWORKS_API_URL}/svm/token/meta`, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    Authorization: process.env.CHAINWORKS_API_AUTH_TOKEN!,
  },
  body: JSON.stringify({ chain: "sol", token: "..." }),
});

​

Connection Events (Socket.IO)

socket.on("connect", () => {
  console.log("Connected successfully");
  // Start making API requests
});

socket.on("connect_error", (error) => {
  console.error("Connection error:", error.message);
  // Handle authentication failures
  if (error.message.includes("unauthorized")) {
    console.error("Invalid API token");
  }
});

socket.on("disconnect", (reason) => {
  console.log("Disconnected:", reason);
  // Handle reconnection if needed
});

​

Reconnection (Socket.IO)

const socket = io(CHAINWORKS_API_URL, {
  transports: ["websocket"],
  auth: {
    token: CHAINWORKS_API_AUTH_TOKEN,
  },
  reconnection: true,
  reconnectionAttempts: 5,
  reconnectionDelay: 1000,
  reconnectionDelayMax: 5000,
});

​

Security Best Practices

1. Never expose tokens in client-side code - Use server-side proxies for browser applications
2. Rotate tokens regularly - Contact us to regenerate compromised tokens
3. Use environment variables - Never hardcode tokens in source code
4. Monitor usage - Track API calls to detect unauthorized access

​

Rate Limits

​

Next Steps

• Quick Start - Get started with your first request
• EVM Endpoints - Explore Ethereum, Base, and BSC endpoints
• SVM Endpoints - Explore Solana endpoints