search

Circle: API Keys

Integral supports an integration to Circle using read-only API keys. Follow these three steps: (1) Enable the "Core Functionality API"; (2) Get a read-only API key from Circle; (3) Add to Integral.

circle-exclamation

Although you can create API keys in the Circle app, the key does nothing if you do not have the Core Functionality API enabled by your Circle support rep.

hashtag
Step 1: Enable the "Core Functionality API" on your Circle account

This is not a self-service option. You will need the Circle team to enable this for you.

  1. If you have already enabled the "Core Functionality API" on your Circle account, you can skip this whole section. Otherwise...

  2. Reach out to your Circle support representative, and ask them to enable the "Core Functionality API" on your Circle account.

  3. Your Circle support representative will send you an MSA to sign.

  4. Once signed, request an API following the steps in the next section.

hashtag
Step 2: Get a read-only API key from Circle

triangle-exclamation

If your Core Functionality API gives both read AND write access via API, you must request a read-only API key from Circle. Please do not create one from the Circle app itself, since you cannot configure the permissions on that page (at the time of writing).

If your Core Functionality API is configured for both read & write, or you are unsure...

  1. Ask your Circle support representative to create a read-only API key for you

  2. They will either send you the key, or you will be able to see it in your Circle account, under Developer > API Keysarrow-up-right

If your Core Functionality API is configured as read-only...

  1. Log into your Circle accountarrow-up-right

  2. Navigate to Developer > API Keysarrow-up-right using the navigation bar

  3. Click on the blue "Create a Key" button

  4. Give your API key a nickname, and leave the IP Allowlist empty. Click "Create".

    1. Note: All other configurations are done in the backend by your Circle rep.

  5. Once created, a pop-up will appear hiding your API key. Click "Show". Copy this key somewhere safe as you will not be able to access it again.

  6. That's it! The Key will show in your list with the nickname you gave it.

Give your API key a recognizable nickname, and leave the IP Allow List empty

Click on "Show" to see your new API key, and store it safely somewhere.

hashtag
Step 3: Upload your read-only Circle API key to Integral

  1. Navigate to +Wallets pagearrow-up-right in Integral

  2. Search for "Circle" and choose the "Circle: API" optionarrow-up-right

  3. Paste your new read-only API key into the search box

  4. Click "Sync"

  5. Your Circle account will be imported with your wallets, along with the transactions

Search for "Circle" in the +Wallets page and choose the API option
Paste in your Circle API key and click "Sync" to import your account transactions

circle-exclamation

Circle uses USD and USDC interchangeably. This means you can deposit USD and withdraw USDC 1-1. To prevent negative USDC balances on your Circle account, Integral creates artificial "swaps" of USD to USDC, or vice versa, where relevant. You will see those labeled as Exchange, with memo "Integral swap USD -> USDC" and priced 1-1 with no capital gain/loss.

Last updated