Authentication

All Squid API requests require authentication via an integrator ID. This page covers how to obtain credentials, use them correctly, and follow security best practices.

---

Get Your Integrator ID

1. Apply via the Integrator ID request form.

2. Check your email — you will receive your integrator ID shortly after applying.

The integrator ID is required for all API, SDK, and widget integrations. The Squid API will reject any request without a valid integrator ID.

---

Using Your Integrator ID

API Requests

Include your integrator ID in the x-integrator-id HTTP header on every request:

curl -X POST 'https://v2.api.squidrouter.com/v2/route' \
  -H 'x-integrator-id: YOUR_INTEGRATOR_ID' \
  -H 'Content-Type: application/json' \
  -d '{ ... }'

SDK Initialization

Pass your integrator ID when creating the Squid SDK instance:

import { Squid } from "@0xsquid/sdk";

const squid = new Squid({
  baseUrl: "https://v2.api.squidrouter.com",
  integratorId: "YOUR_INTEGRATOR_ID",
});

await squid.init();

Widget Configuration

Include your integrator ID in the widget configuration:

<SquidWidget
  config={{
    integratorId: "YOUR_INTEGRATOR_ID",
    // ... other config options
  }}
/>

---

Error Response

If the integrator ID is missing or invalid, the API returns:

{
  "message": "x-integrator-id header is missing",
  "type": "UNAUTHORIZED"
}

---

Security Best Practices

Never expose your integrator ID in client-side code if your ID has elevated privileges or custom rate limits. For public-facing widget integrations, the standard integrator ID is safe to include in frontend code.

• Server-side usage: For API integrations, make Squid API calls from your backend server, never directly from browser JavaScript.

• Environment variables: Store your integrator ID in environment variables (.env), not in source code.