Calico®
v2
  • v2
  • v1
API Reference
getCalico.com
API Reference
getCalico.com
v2
  • v2
  • v1
v2
  • v2
  • v1
  1. Platform API
  • Getting Started
  • Calico Connect
  • Use Cases
  • Pagination
  • Versioning
  • Platform API
    • Try it out
    • Changelog
    • Authentication
      • Authorization Callback
    • Providers
      • Add providers
      • List connected providers
      • Remove providers
    • Assets
      • User assets
      • Refresh asset list
    • Transactions
      • Transactions
      • Refresh transactions
  • Resources
    • Response codes
    • FAQs
  • Release Notes
    • Calico Connect 1.5 - March 2026
    • Platform API v2 - March 2026
  • Schemas
    • Schemas
      • CalicoErrorResponse
      • RefreshResponse
    • AddProvidersRequest
    • AddProvidersResponse
    • AddProvidersData
    • ListProvidersResponse
    • ListProvidersData
    • ProviderMetadata
    • DeleteProvidersRequest
    • DeleteProvidersResponse
    • DeleteProvidersData
    • ProviderMetadataV2.1
    • ConnectedProvidersMetadataV2.1
    • GetAssetsResponse
    • GetAssetsData
    • AssetPosition
    • GetTransactionsResponse
    • GetTransactionsData
    • TransactionCategorization
    • TransactionType
    • FeeItem
    • FeeObject
    • CurrencyValue
    • Transactions data
    • Input only transactions
    • Send transaction data
    • Receive transaction data
    • Output only transaction data
    • Transactions with input and output
    • Uncategorized transaction data
    • CryptoSourceCredentialAuthType
    • RefreshResponseData
    • IntegrationResponse
    • IntegrationData
    • AuthMetaData
    • PageData
    • APIConnection
    • WalletConnection
    • OAuth2Connection
    • ErrorItem
    • ProviderId
    • GetConsentURLForThirdPartyResponse
  1. Platform API

Try it out

Calico in action#

This documentation includes example data using a test app and test wallet for live results.
Follow the steps below to connect the test wallet and retrieve data through the Calico Platform API.

1. Get started#

Start the Try it feature.
Go to the Add providers documentation page.
Select "Try it".
Part of documentation page for the Add providers endpoint with the Try it button.
Select "Try It"

2. Get a token#

All connections must be authenticated and authorized. And a token sent with all data endpoints. For more, see our guide on authentication and tokens.
Select "Get token" to authorize the test app.
Part of the Try it out panel for the Add providers endpoint including the Get Token button.
Select "Get Token"

3. Calico Connect#

The Calico Connect widget will prompt you to log in to Calico Documentation.
Select "Sign up".
Popup welcome screen to start the authorization flow. The page includes a sign up link.
Complete sign up

4. Sign up#

Enter your email address. You’ll receive a code via email from: Calico Documentation + root@auth0.com
The code will expire in 10 minutes. If you don’t receive the email, check your spam folder.
Enter the code.

5. Add a provider#

Now you have a token. Be sure the "Access Token" box is populated under "Credentials" in the "Try it out" panel.
Next, you’ll need to add a wallet or exchange which has the crypto data to be shared. The documentation includes a test Ethereum wallet as an example. You do not need to make any changes. However, you can use your own test wallet by changing the body of the request.
❗
If you use your own wallet, be sure to complete step eight to remove your wallet when done.
Select "Send" to complete adding the wallet.
Part of the Try it out panel for the Add providers endpoint with a Send button. The access token is hidden.
Select "Send"
Check the result for a success message:
{
    "added": true
}
If you try to add a connected wallet again, you'll receive a false result.
{
    "data": {
        "added": false
    },
    "errors": []
}
To check if a wallet has already been added, use the connected providers endpoint to list connections.

6. Get Assets#

Return testing
If you're testing this endpoint after initial setup, you'll need to refresh the data first.
Go to Refresh Asset List.
Select "Try it" then "Send".
Follow directions below.
Retrieve the asset information for the connected wallet.
Go to the User Assets documentation page.
Select "Try it" then "Send".
Part of the Try it out panel for the Get assets endpoint including the Send button. Query parameter options and the body of a successful response in JSON are also displayed in the panel.
To get assets, hit send.

7. Get Transactions#

Return testing
If you're testing this endpoint after initial setup, you'll need to refresh the data first.
Go to Refresh Transactions.
Select "Try it" then "Send".
Follow directions below.
Retrieve the transaction information for the connected wallet.
Go to the Transactions documentation page.
Select "Try it" then "Send".
The parameters have example dates set by variables. You may change these to meet your testing needs.
Part of the Try it out panel for the Get transactions endpoint including the Send button. Query parameter options and the body of a successful response in JSON are also displayed in the panel.
To get transactions, hit send.

8. Remove wallet#

After you're done with the steps above, you may use the Remove providers endpoint to remove the wallet.
❗
If you're using your own wallet or exchange and have finished testing, be sure to complete this step.
Go to the Remove providers documentation page.
Select "Try it".
If using the Calico test wallet, do nothing. If using your own, change the wallet address in the body of the request.
Select "Send."

9. Success!#

You've tested the Calico Platform API!
What's next? Get in touch to see how Calico can help your use case!
Tips!
1.
The initial token times out after an hour. After that time, select "Get token" to sign in again.
2.
If you return to test after a day, you may need to refresh data before using the Assets or Transactions endpoints. Use the Refresh endpoints.
3.
If you receive an empty response from the Assets or Transactions endpoints, the data may need to be refreshed. Use the Refresh endpoints.
1253877.1.0
Previous
Platform API
Next
Changelog