Installing our SDK

Install the SDK via npm or yarn.
npm install --save @0xsquid/sdk
yarn add @0xsquid/sdk

Get an integratorId

To use the SDK, you need to register an integratorId with the Squid Team, please complete this form to acquire one.

Base URLs


Code example

import { Squid } from "@0xsquid/sdk";
(async () => {
// instantiate the SDK
const squid = new Squid();
baseUrl: "", // for mainnet use ""
integratorId: "your-integrator-id"
// init the SDK
await squid.init();
console.log("Squid inited");

Advanced configuration

Check out Advanced set up if you're a power user.