Circle SDKs

Use the TypeScript SDK to quickly get your codebase up and running with Circle APIs.

Circle’s SDKs help you integrate Circle APIs. The TypeScript SDK is open source. If you find a bug or need a feature, file an issue or contribute to the node-sdk.

Note: This page contains code snippets and examples that can be run as is or incorporated into your apps.

Installing the SDK

Run one of the following commands from your project directory to install the SDK.

Node

npm install @circle-fin/circle-sdk --save
# or
yarn add @circle-fin/circle-sdk

Configuration

import { Circle, CircleEnvironments } from "@circle-fin/circle-sdk";

const circle = new Circle(
  "<your-api-key>",
  CircleEnvironments.sandbox, // API base url
);

List balances

async function listBalances() {
  const balancesRes = await circle.balances.listBalances();
}

Create a crypto payment

async function createCryptoPayment() {
  const createCryptoPaymentRes =
    await circle.paymentIntents.createPaymentIntent({
      idempotencyKey: "5c6e9b91-6563-47ec-8c6d-0ce1103c50b3",
      amount: {
        amount: "3.14",
        currency: "USD",
      },
      settlementCurrency: "USD",
      paymentMethods: [
        {
          chain: "ETH",
          type: "blockchain",
        },
      ],
    });
}

Get a crypto payment

async function getCryptoPayment(id: string) {
  const cryptoPayment = await circle.paymentIntents.getPaymentIntent(id);
}