Circle SDKs

Use our SDKs to quickly get your codebase up and running with Circle APIs.

Circle’s SDKs are developer tools that enable you to integrate your code with Circle APIs. Because Circle SDKs are open source, you can contribute to them directly. If you find bugs or missing features,file an issue or contribute back to the node-sdk.

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

Circle offers SDKs for Typescript, Java and Python.

Installing the SDK

You can run one of the two commands below from your project directory to install the SDK.

Node

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

Configuration

Typescript

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

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

List balances

Typescript

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

Create a crypto payment

Typescript

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

Typescript

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