Anchorage Digital
Vaults, wallets, deposit addresses, transfers, trading, staking, Atlas settlement, tax reporting, subaccounts and webhooks.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 151 actions:
| Action | Purpose | Parameters |
|---|---|---|
| get_apikey | Permissions required: none Get the user information for your API key. As with any endpoint, a signature included in the request will be validated. This can be used to confirm the associated signing key as well information about the current API key. | No parameters |
| post_atlas_settlements | Permissions required: Propose and Accept settlements Propose a settlement with a counterparty for a list of assets coming from and/or arriving into wallets owned by your participant. Positive amounts indicate funds to be received and negative amounts indicate funds to be sent. json 'walletId': 'd4578f401daadff65615236c5ad1e12c', 'quantity': '-1.1', 'assetType': 'BTC' , 'walletId': '43a9aeac02c851f4868f9d89aabde494', 'quantity': '20.62', 'assetType': 'ETH' For example, t | Api-Signature (string) required Api-Timestamp (integer) required data: { . acceptorId (string) . applyPostLock (boolean) . clientReferenceId (string) . idempotentId (string) . proposerId (string) . useGasStation (boolean) . vaultId (string) . walletAmounts (array) } (object) required |
| get_atlas_settlements | Permissions required: Read vault activity Get settlements proposed by you or proposed to you. | afterId (string) limit (integer) |
| post_atlas_settlements_by_settlement_id_reject | Permissions required: Propose and Accept settlements or Authorize Settlements Rejects a proposed settlement for your Atlas participant. Proposed settlements cannot be rejected if they have already been authorized. | settlementId (string) required Api-Signature (string) required Api-Timestamp (integer) required |
| post_atlas_settlements_by_settlement_id_authorize | Permissions required: Authorize Settlements After your participant has proposed a settlement or accepted a settlement proposal, the details of the settlement must be authorized. To authorize via API, the API key must have a special permission. Otherwise, authorization takes place in the app according to organization policy. | settlementId (string) required participantId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . acceptorId (string) . proposerId (string) . walletAmounts (array) } (object) required |
| post_atlas_settlements_by_settlement_id_accept | Permissions required: Propose and Accept settlements and Read vault activity Accept a proposed settlement and select wallets to receive funds to and/or send funds from. | settlementId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . useGasStation (boolean) . vaultId (string) . walletAmounts (array) } (object) required |
| get_atlas_settlements_by_settlement_id | Permissions required: Read vault activity Get a single settlement by its ID. | settlementId (string) required |
| post_atlas_directory_counterparties | Permissions required: Propose Trusted Counterparty Propose adding a new trusted counterparty for a participant. | Api-Signature (string) required Api-Timestamp (integer) required data: { . counterpartyId (string) . description (string) . idempotentId (string) . participantId (string) } (object) required |
| get_atlas_directory_counterparties | Permissions required: Read vault activity Get trusted counterparties. | participantId (string) required limit (integer) afterId (string) |
| get_atlas_directory_counterparties_by_counterparty_id | Permissions required: Read vault activity Get a single trusted counterparty by its ID. | counterpartyId (string) required participantId (string) required |
| get_atlas_directory_participants_by_participant_id | Permissions required: Read vault activity Get a single participant by its ID. | participantId (string) required |
| get_atlas_directory_participants | Permissions required: Read vault activity Get the list of participants you have access to. | limit (integer) afterId (string) |
| get_collateral_management_packages | Permissions required: Read vault activity Get collateral packages. | afterId (string) limit (integer) |
| post_collateral_management_packages | Permissions required: Manage Collateral Packages and Read vault activity Creates a new collateral package in the Collateral Management service. | Api-Signature (string) required Api-Timestamp (integer) required data: { . acceleratedMarginCall (object) . clientReferenceId (string) . collateralAssetsConfig (array) . critical (object) . ltvRoundingPrecision (integer) . marginCall (object) . marginReturn (object) . pledgorId (string) . priceStrategy (string) . securedPartyId (string) } (object) required |
| patch_collateral_management_packages_by_package_id | Permissions required: Manage Collateral Packages and Read vault activity Updates an existing collateral package in the Collateral Management service. | packageId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . acceleratedMarginCall (object) . autoDeleveraging (object) . clientReferenceId (string) . collateralAssetsConfig (array) . critical (object) . isActive (boolean) . ltvRoundingPrecision (integer) . marginCall (object) . marginReturn (object) . priceStrategy (string) } (object) required |
| get_collateral_management_exposures | Permissions required: Read vault activity Get Exposures. | afterId (string) limit (integer) |
| post_collateral_management_exposures | Permissions required: Manage Collateral Exposures and Read vault activity Creates a new exposure in the Collateral Management service. | Api-Signature (string) required Api-Timestamp (integer) required data: { . assetTrackingConfig (object) . clientReferenceId (string) . collateralPackageID (string) . priceStrategy (string) . type (string) } (object) required |
| patch_collateral_management_operations_by_operation_id | Permissions required: Manage Collateral Packages and Read vault activity Update an existing operation in the Collateral Management service. Only the fields provided in the request body will be updated. | operationId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . action (string) . asset (object) . notes (string) . quantity (string) . type (string) . typeId (string) } (object) required |
| post_collateral_management_operations | Permissions required: Manage Collateral Packages and Read vault activity Create a new operation in the Collateral Management service. | Api-Signature (string) required Api-Timestamp (integer) required data: { . action (string) . asset (object) . idempotentId (string) . notes (string) . quantity (string) . type (string) . typeId (string) } (object) required |
| get_collateral_management_operations | Permissions required: Read vault activity Get all the operations that were booked for collateral packages and exposures. | afterId (string) limit (integer) |
| get_collateral_management_price_sources | Permissions required: Read vault activity Returns the assets trading pairs available for specific price sources exchanges. This endpoint queries live price data from the Kafka cache and returns supported exchanges. Optionally filter by a specific exchange using the 'exchange' query parameter. | exchange (string) |
| post_collateral_management_packages_by_package_id_requests_margin_return | Permissions required: Manage Collateral Packages and Read vault activity Initiate a margin return: a decrease in the collateral held against a collateral package by returning a list of assets from the secured party's collateral wallets to the pledgor's return wallets. The package must be in MARGIN_RETURN state. A margin return is fulfilled by creating a two-way Atlas settlement. Unlike a freeform settlement proposal, the counterparty, vault, and the wallets on both sides are not supplied by t | packageId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . assetAmounts (array) . idempotencyKey (string) . useGasStation (boolean) } (object) required |
| post_collateral_management_packages_by_package_id_requests_pay_up | Permissions required: Manage Collateral Packages and Read vault activity Initiate a pay-up: an increase in exposure on a collateral package by sending additional loan funds from the secured party to the pledgor's preconfigured disbursement wallet for each requested exposure asset. The package must be in HEALTHY or MARGIN_RETURN state, and the increase must not push the package's projected state out of those two states. A pay-up is fulfilled by creating a two-way Atlas settlement. In both case | packageId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . assetAmounts (array) . idempotencyKey (string) . useGasStation (boolean) } (object) required |
| get_deposit_attributions_attributions | Permissions required: Read Deposit Attribution or Deposit Attribution. Returns all Deposit Attributions for an Organization based on the provided query parameters. Default sorting will be ascending order by createdAt. | afterId (string) limit (integer) status (string) startDateTime (string) endDateTime (string) attributedAtStartDateTime (string) attributedAtEndDateTime (string) subaccountIds (array) |
| patch_deposit_attributions_by_deposit_transaction_id | Permissions required: Deposit Attribution. Attribute a deposit by providing information about the originator. Only attributions in PENDING status can be attributed. Once the attribution is successfully performed the attribution status moves from PENDING to UNDER_REVIEW. For attributions performed via API the attributionType will always be CLIENT_API. | depositTransactionId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . notes (string) . originatorCountry (string) . originatorName (string) . sourceWalletType (string) } (object) required |
| post_deposit_attributions_by_deposit_transaction_id_spam | Permissions required: Deposit Attribution. Attribute a deposit as spam. Only attributions in PENDING status can be attributed. Once the attribution is successfully performed the attribution status moves from PENDING to ATTRIBUTED. For any spam attribution performed via API, the attributionType will automatically be set to SPAM and the deposit's funds will cease to be available. | depositTransactionId (string) required Api-Signature (string) required Api-Timestamp (integer) required data (object) required |
| post_onboarding_customers | Permissions required: Onboarding Initiate onboarding application for a new customer of Anchorage Digital | data: { . affiliateId (string) . applicationType (string) . applicationVersion (integer) . entries (array) . externalId (string) . submit (boolean) } (object) required |
| get_onboarding_customers | Permissions required: Onboarding List all customers onboarding application status, missing information and previously uploaded information. | afterId (string) limit (integer) |
| get_onboarding_customers_by_customer_id | Permissions required: Onboarding Get customer onboarding application status, missing information and previously uploaded information. | customerId (string) required |
| put_onboarding_customers_by_customer_id | Permissions required: Onboarding Update an existing customer onboarding application. The application data will be updated to match the entries of the update payload. If any field is invalid, the entire update will fail and no data will be updated. | customerId (string) required data: { . entries (array) } (object) required |
| post_onboarding_customers_by_customer_id_document | Permissions required: Onboarding Request a signed URL for uploading document images for the existing customer onboarding application Note that the URL expires after 15m, you can still generate a new URL if this one expires. If the image file is never uploaded, the document will show as missing in the GET response and a new signed URL must be requested. | customerId (string) required data: { . documentType (string) } (object) required |
| post_onboarding_customers_by_customer_id_submit | Permissions required: Onboarding Indicate that a customer onboarding application is complete and can be submitted for screening | customerId (string) required |
| post_onboarding_agreements_by_agreement_type | Permissions required: Onboarding Creates a new agreement questionnaire | agreementType (string) required data: { . frameAncestor (string) . legalEntityName (string) . returnUrl (string) . signerEmail (string) . signerFirstName (string) . signerLastName (string) . termsAgreementFormat (string) } (object) required |
| get_onboarding_agreements_by_agreement_type | Permissions required: Onboarding Retrieves all the agreements questionnaires for the specified agreement type | agreementType (string) required status (string) afterId (string) limit (integer) |
| get_onboarding_agreements_by_agreement_type_by_agreement_id | Permissions required: Onboarding Retrieves the agreement questionnaire for the specified agreement type and agreement ID | agreementType (string) required agreementId (string) required |
| post_onboarding_subaccounts | Permissions required: Onboarding Initiate onboarding application for a new customer subaccount of Anchorage Digital | data: { . entries (array) . externalId (string) . name (string) . submit (boolean) } (object) required |
| get_onboarding_subaccounts | Permissions required: Onboarding List all customer subaccounts onboarding application status, missing information and previously uploaded information. | afterId (string) limit (integer) |
| get_onboarding_subaccounts_by_subaccount_id | Permissions required: Onboarding Get customer subaccount onboarding application status, missing information and previously uploaded information. | subaccountId (string) required |
| put_onboarding_subaccounts_by_subaccount_id | Permissions required: Onboarding Update data of an existing customer subaccount onboarding application | subaccountId (string) required data: { . entries (array) } (object) required |
| post_onboarding_subaccounts_by_subaccount_id_submit | Permissions required: Onboarding Indicate that a customer subaccount onboarding application is complete and can be submitted for screening | subaccountId (string) required |
| post_stablecoins_conversion | Permissions required: Convert Stablecoins Create a stablecoin conversion, either issuance or redemption. Issuance is when USD is converted to the stablecoin. Redemption is when the stablecoin asset is converted to USD. | data: { . amount (string) . destinationAssetType (string) . destinationWalletId (string) . idempotencyKey (string) . sourceAssetType (string) . sourceWalletId (string) } (object) required |
| get_stablecoins_history | Permissions required: Convert Stablecoins Retrieve the history of stablecoin issuance and redemption operations for your organization. Results are paginated and ordered by creation time newest first. | limit (integer) lastCreatedAt (string) |
| get_stablecoins_reserves | Permissions required: Read vault activity Retrieve the daily reserves reconciliation history for a stablecoin your organization is entitled to. Results are paginated and ordered by creation time newest first. | stablecoin (string) required startDate (string) endDate (string) limit (integer) lastCreatedAt (string) |
| get_stablecoins_reserves_entitled_stablecoins | Permissions required: Read vault activity List the stablecoins whose reserves history your organization is entitled to view. Pass any returned symbol as the stablecoin query parameter to GET /stablecoins/reserves to retrieve that stablecoin's daily reserves reconciliation history. Returns an empty array when your organization cannot view reserves history for any stablecoin. | No parameters |
| get_statement_types | Permissions required: Read Statement List the available statement types. | afterId (string) limit (integer) |
| get_statements | Permissions required: Read Statement List the available statements. | afterId (string) limit (integer) ids (array) typeIds (array) customerIds (array) createdAfter (string) createdBefore (string) correctedAfter (string) correctedBefore (string) |
| get_statements_by_statement_id | Permissions required: Read Statement Get the details for a statement. | statementId (string) required |
| get_statements_by_statement_id_download | Permissions required: Read Statement Download a statement as a PDF file. This endpoint streams the PDF file directly. The response body contains the binary content of the PDF file. | statementId (string) required |
| get_subaccounts_accounts_by_subaccount_id_wallets | Permissions required: Subaccount or Read Subaccount Return wallets linked to a subaccount | subaccountId (string) required networkIds (array) |
| get_subaccounts_accounts_by_subaccount_id_bank_info | Permissions required: Subaccount or Read Subaccount Return bank information for a subaccount | subaccountId (string) required |
| post_subaccounts_customers_by_customer_id_accounts | Permissions required: Subaccount Open a new subaccount for the program customer DEPRECATED, please use /onboarding/accounts | customerId (string) required data: { . externalSubaccountId (string) . fees (array) . name (string) } (object) required |
| get_subaccounts_customers_by_customer_id_accounts | Permissions required: Subaccount or Read Subaccount Return all subaccounts associated to a customerId | customerId (string) required endDate (string) afterId (string) statuses (array) limit (integer) |
| get_subaccounts_customers_accounts | Permissions required: Subaccount or Read Subaccount Return all subaccounts associated for an organization | subaccountIds (array) externalIds (array) endDate (string) afterId (string) statuses (array) limit (integer) |
| patch_subaccounts_accounts_by_subaccount_id | Permissions required: Subaccount Update a subaccount | subaccountId (string) required data: { . beneficiaryGroup (array) . contingencyBeneficiaryGroup . fees (array) . programSignerGroup (array) } (object) required |
| patch_subaccounts_accounts_by_subaccount_id_interest_enrollment | Permissions required: Subaccount Set the subaccount's enrollment in the fiat cash interest program. The subaccount's enrollment state is updated before this call returns, and the response reports it. Its fiat wallets are then aligned to that state in the background, so they follow the 202 rather than coincide with it. If that alignment proves impossible the stored state is rolled back, and a later read reports the previous value: the state means interest is active on the subaccount, not that a | subaccountId (string) required Api-Signature (string) required Api-Timestamp (integer) required Idempotency-Key (string) required data: { . interestEnrolled (boolean) } (object) required |
| post_subaccounts_transactions | Permissions required: Subaccount Create new transactions between subaccounts of the same Program Customer. This is a transactional operation, all transactions will be created successfully or none will. | Api-Signature (string) required Api-Timestamp (integer) required data: { . transactions (array) } (object) required |
| get_subaccounts_transactions | Permissions required: Subaccount or Read Subaccount Return all the transactions, sorted by the creation date, the client has access to | subaccountId (string) afterId (string) limit (integer) statuses (array) types (array) startDate (string) endDate (string) |
| get_subaccounts_transactions_by_transactions_ids | Permissions required: Subaccount or Read Subaccount Return the requested transactions, sorted by the creation date, the client has access too | transactionsIds (array) required startDate (string) endDate (string) afterId (string) limit (integer) |
| post_subaccounts_transactions_allocations | Permissions required: Subaccount Create new allocation of pre-funded values between the Funding and Program Customers' subaccounts. This is a transactional operation, all transactions will be created successfully or none will. | Api-Signature (string) required Api-Timestamp (integer) required data: { . allocations (array) . idempotentId (string) } (object) required |
| get_subaccounts_transactions_allocations | Permissions required: Subaccount or Read Subaccount Retrieves a filtered set of transactions that are connected to funding allocations. | subaccountIds (array) startDate (string) endDate (string) transactionsTypes (array) afterId (string) limit (integer) |
| post_subaccounts_by_subaccount_id_fiat_withdrawals | Permissions required: Subaccount Creates a USD Withdrawal Request for an Asset within a Subaccount FIAT only for now This will trigger an e-mail to be sent to the program customer to authorize the withdrawal. | subaccountId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . asset (object) . customerDetails (object) } (object) required |
| get_subaccounts_by_subaccount_id_fiat_withdrawals | Permissions required: Subaccount or Read Subaccount Retrieves a filtered set of Withdrawal Requests within a Subaccount FIAT only for now. | subaccountId (string) required withdrawalStatuses (array) startDate (string) endDate (string) afterId (string) limit (integer) |
| delete_subaccounts_by_subaccount_id_fiat_withdrawals_by_transaction_id | Permissions required: Subaccount Cancels a Withdrawal Request | subaccountId (string) required transactionId (string) required Api-Signature (string) required Api-Timestamp (integer) required |
| get_subaccounts_by_subaccount_id_fiat_withdrawals_by_transaction_id | Permissions required: Subaccount Get a USD Withdrawal Request | subaccountId (string) required transactionId (string) required |
| post_subaccounts_billing_charges | Permissions required: Subaccount Create Manual Billing Charge | data: { . charges (array) . feeType (string) . idempotentId (string) . interval (object) } (object) required |
| delete_subaccounts_billing_charges_by_charge_id | Permissions required: Subaccount Cancel Manual Billing Charge | chargeId (string) required |
| get_tax_accounts | List all tax accounts for the client's organization. | limit (integer) afterId (string) |
| get_tax_accounts_by_account_id_transactions | List deposit transactions for a specific tax account. | accountId (string) required startDate (string) endDate (string) limit (integer) afterId (string) hasCostBasis (boolean) |
| patch_tax_accounts_by_account_id_transactions_by_transaction_id | Update the cost basis for a specific transaction. Allows customers to submit cost basis for assets that are deposited at Anchorage. Note, one deposit can contain up to 100 individual tax lots. | accountId (string) required transactionId (string) required data: { . lots (array) } (object) required |
| get_tax_transactions_by_subaccount_id | Permissions required: Subaccount List tax transactions of a subaccount. | subaccountId (string) required startDate (string) endDate (string) |
| patch_tax_transaction_by_transaction_id | Permissions required: Subaccount Update the cost basis for a deposit or withdraw transaction. | transactionId (string) required data: { . acquisitionDatetime (string) . assetType (string) . data (object) . lots (array) . type (string) } (object) required |
| post_tax_transaction_by_transaction_id_tag | Permissions required: Subaccount Tag a prior transaction for tax purposes. Under development | transactionId (string) required data: { . accountId (string) . distributionCode (string) . postponedLateReason (string) . tag (string) . taxYear (string) . totalDistribution (boolean) } (object) required |
| delete_tax_transaction_by_transaction_id_tag | Permissions required: Subaccount Remove tax tag for a prior transaction. Under development | transactionId (string) required accountId (string) required |
| get_tax_inventory_by_subaccount_id_by_asset_type_id | Permissions required: Subaccount List user's inventory for an asset. | subaccountId (string) required assetTypeId (string) required limit (integer) offset (integer) |
| get_tax_inventory_summary_by_subaccount_id | Permissions required: Subaccount List user's inventory summary for all assets. | subaccountId (string) required limit (integer) offset (integer) |
| get_tax_gains_costbasis_by_subaccount_id | Permissions required: Subaccount List subaccount's breakdown of combined cost basis, proceeds and gains/losses | subaccountId (string) required startDateTime (string) required endDateTime (string) required |
| get_tax_gains_summary_by_subaccount_id | Permissions required: Subaccount List subaccount's gains for a period breakdown to short term, long term and total | subaccountId (string) required startDateTime (string) required endDateTime (string) required |
| get_tax_subaccounts_by_subaccount_id_forms | Permissions required: Subaccount Get subaccount's generated tax forms | subaccountId (string) required |
| get_tax_clients_by_customer_id_forms | Permissions required: Subaccount Get a program customer's generated tax forms | customerId (string) required |
| post_trading_quote | Permissions required: Execute trades Request a quote Idempotent Requests This endpoint supports idempotent requests section/Idempotency so that quote is not requested twice if an API call was interrupted and must be retried. To send an idempotent request, include the idempotentId field in the body of the POST request. | data: { . accountId (string) . currency (string) . idempotentId (string) . quantity (string) . quantityRounding (boolean) . side (string) . tradingPair (string) } (object) required |
| post_trading_quote_accept | Permissions required: Execute trades Accept a quote by its quoteID and side. Idempotent Requests This endpoint supports idempotent requests section/Idempotency so that a quote cannot be accepted twice if an API call was interrupted and is retried. To send an idempotent request, include the idempotentId field in the body of the POST request. | Api-Signature (string) required Api-Timestamp (integer) required data: { . accountId (string) . allowedSlippage (string) . idempotentId (string) . quoteID (string) . side (string) . vaultID (string) } (object) required |
| post_trading_order | Permissions required: Execute trades Place an order, either Market or Limit, currently only FillOrKill is supported. One of accountId or subaccountId must be specified but not both. | data: { . accountId (string) . allocation (array) . clOrderId (string) . currency (string) . limitPrice (string) . orderType (string) . quantity (string) . side (string) . subaccountId (string) . symbol (string) . timestamp (string) } (object) required |
| get_trading_orders | Permissions required: Execute trades or Read trade activity List all orders. With the permission Read trade activity all orders of the organization may be read. With the permission Execute trades only the orders created by this API key may be read. Orders are sorted in a descending order by their timestamp, i.e. the most recent order or the order with a timestamp closest to endDate is listed first. When filtering by subaccountId, the allocation information is included but filtered to show onl | accountId (string) subaccountId (string) startDateTime (string) endDateTime (string) status (array) orderIds (array) clientOrderIds (array) limit (integer) orderTypes (array) |
| get_trading_orders_by_order_id | Permissions required: Read trade activity or Execute trades if order created by this API key Get order by ID, where the ID can be anchorage generated orderId or clientOrderId | orderId (string) required |
| get_trading_trades | Permissions required: Execute trades or Read trade activity List all trades. With the permission Read trade activity all trades of the organization may be read. With the permission Execute trades only the trades created by this API key may be read. Trades are sorted in a descending order by their timestamp, i.e. the most recent trade or the trade with a timestamp closest to endDate is listed first. Filters You may optionally supply the following filters: - Specify a tradingPair to filt | startDate (string) endDate (string) startDateTime (string) endDateTime (string) status (array) side (string) tradingPair (string) accountId (string) subaccountId (string) orderId (string) vaultId (string) tradeIds (array) limit (integer) |
| get_trading_trades_by_trade_id | Permissions required: Read trade activity or Execute trades if trade created by this API key Get trade by ID. | tradeId (string) required |
| get_trading_positions | Permissions required: Execute trades or Read trade activity Get the list of outstanding trading positions. | No parameters |
| get_trading_settlements | Permissions required: Execute trades or Read trade activity List of all settlements. With permission Read trade activity all settlements of the organization may be read. With permission Execute trades only settlements this api key has created may be read. Settlements are sorted in a descending order by their timestamp, i.e. the most recent settlement or the settlement with a timestamp closest to endDate is listed first. Filters You may optionally supply the following filters: - Specify | startDate (string) endDate (string) status (array) vaultID (string) limit (integer) excludePositions (boolean) excludeSettlementInstructions (boolean) accountId (string) |
| get_trading_settlements_by_settlement_id | Permissions required: Execute trades or Read trade activity Get settlement details by ID. | settlementId (string) required excludeTrades (boolean) excludePositions (boolean) excludeSettlementInstructions (boolean) |
| get_trading_settlements_by_settlement_id_trades | Permissions required: Execute trades or Read trade activity List trades for the provided settlement. With the permission Read trade activity all trades of the organization may be read. With the permission Execute trades only the trades created by this API key may be read. Trades are sorted in a descending order by their timestamp i.e. the most recent trade or the trade with a timestamp closest to endDateTime is listed first. | settlementId (string) required startDateTime (string) endDateTime (string) side (string) tradingPair (string) afterId (string) limit (integer) |
| get_trading_accounts | Permissions required: Read trade activity Get the list of trading accounts | No parameters |
| get_trading_accounts_by_account_id | Permissions required: Read trade activity Get trading account details by ID. | accountId (string) required |
| get_trading_accounts_by_account_id_balances | Permissions required: Read trade activity Get the trading account balances of fiat and digital assets | accountId (string) required assetType (string) |
| get_trading_accounts_by_account_id_credit | Permissions required: Read trade activity Get the credit limit and usage of a trading account per asset. Current USD prices are not returned, only assets and their quantity. Still under development, return empty replies. | accountId (string) required |
| get_trading_marketdata | Permissions required: Execute trades or Read trade activity Get real-time market data snapshot for a trading symbol from the liquidity provider. | symbol (string) required accountId (string) subaccountId (string) sizeBuckets (array) amountBuckets (array) depth (integer) priceIncrement (string) |
| get_trading_pairs | Permissions required: Execute trades or Read trade activity List all of the supported trading pairs for your organization. Each trading pair object includes a description and trading symbol ex. BTC-USD, which usually corresponds to two asset ticker symbols. Optionally, a trading pair object includes a reference data object that details the trading precision context: minimum size increment and price increment. | No parameters |
| post_trading_async_order | Permissions required: Execute trades Place an order, either Limit, StopLoss, StopLimit or TakeProfitLimit currently FillOrKill, ImediateOrCancel or GoodTillCancel are supported. One of accountId or subaccountId must be specified but not both. | data: { . accountId (string) . allocation (array) . clOrderId (string) . currency (string) . limitPrice (string) . orderType (string) . parameters (object) . quantity (string) . side (string) . specLotId (string) . subaccountId (string) . symbol (string) . timeInForce (string) . timestamp (string) } (object) required |
| post_trading_async_order_cancel | Permissions required: Execute trades Cancels an async order. | orderId (string) clOrderId (string) |
| get_trusted_destinations | Permissions required: Read vault activity List trusted destinations | afterId (string) limit (integer) ownerType (string) ownerId (string) assetTypeId (string) kinds (array) |
| post_trusted_destinations | Permissions required: Manage Trusted Destinations Create new Trusted Destinations | data: { . idempotentId (string) . owner (object) . trustedDestinations (array) } (object) required |
| get_trusted_destinations_by_creation_request_id_status | Permissions required: Read vault activity Check status of Trusted Destinations | creationRequestId (string) required |
| delete_trusted_destinations_by_creation_request_id_cancel | Permissions required: Manage Trusted Destinations Cancel ongoing creation of Trusted Destinations | creationRequestId (string) required |
| get_trusted_destinations_by_trusted_destination_id | Permissions required: Read vault activity Get a single Trusted Destination by its ID. | trustedDestinationId (string) required ownerType (string) ownerId (string) |
| delete_trusted_destinations_by_trusted_destination_id | Permissions required: Manage Trusted Destinations Delete a Trusted Destination | trustedDestinationId (string) required ownerType (string) ownerId (string) |
| get_vaults_by_vault_id_addresses | Permissions required: Read vault activity or Create address Get all addresses for the asset type within the specified vaultId. | vaultId (string) required assetType (string) required afterId (string) limit (integer) |
| get_vaults_by_vault_id_wallets | Permissions required: Read vault activity Get all wallets for the specified vaultId. | vaultId (string) required afterId (string) networkId (string) assetType (string) limit (integer) filterByIsArchived (boolean) |
| post_vaults_by_vault_id_wallets | Permissions required: Create address Create a wallet in the specified vaultId. | vaultId (string) required data: { . activateAllCompatibleNetworks (boolean) . async (boolean) . compatibleNetworkIds (array) . idempotencyKey (string) . networkId (string) . subaccountId (string) . walletName (string) } (object) required |
| post_vesting_balances | Get vesting balances for multiple allocation IDs in a single request. Returns per-allocation results with balance breakdowns including available, unvested, and locked amounts. Individual allocation errors are returned inline rather than failing the entire batch. | data: { . allocationIds (array) . stakeholderId (string) } (object) required |
| get_vesting_balances_by_allocation_id | Get vesting balances for a specific allocation ID. Returns the current balance breakdown including available, unvested, and locked amounts. | allocationId (string) required stakeholderId (string) |
| get_tags | List tags filtered by ownership type and/or entity. When entityId is provided, returns tags applied to that entity. When type is provided, filters tag definitions by ownership type. | tagType (string) entityId (string) tagTypes (string) afterId (string) limit (integer) sort (string) order (string) |
| post_tags | Create a new tag. Tags are also auto-created on first use via POST /v2/tags/apply, so explicit creation is optional. | data: { . name (string) . tagType (string) } (object) required |
| post_tags_apply | Apply a set of tags to an entity, replacing the entity's existing tags of the given tag type. Tags are auto-created if they do not exist, and an empty list clears the entity's tags of that type. | data: { . entityId (string) . entityType (string) . tags (array) . tagType (string) } (object) required |
| delete_tags_apply_by_entity_id_by_tag_name | Remove a specific tag from an entity. Tag name matching is case-insensitive. | entityId (string) required tagName (string) required |
| get_tags_search | Search for entities that have specific tags applied. Supports cursor-based pagination. | name (string) required type (string) afterId (string) limit (integer) |
| get_virtual_accounts_by_id | Permissions required: Virtual accounts or Read vault activity Get a single virtual account by its id. No signature is required for this read. | id (string) required |
| get_wallets | Permissions required: Read vault activity List wallet metadata for the current user. | afterId (string) subaccountIds (array) networkId (string) assetType (string) limit (integer) filterByIsArchived (boolean) searchByAddress (string) minUsdValue (string) |
| get_wallets_by_wallet_id | Permissions required: Read vault activity Get wallet details for the specified walletId. | walletId (string) required filterByIsArchived (boolean) |
| post_wallets_by_wallet_id_activate | Permissions required: Create address Activate the existing wallet identified by walletId on additional networks that share the same cryptographic key derivation e.g. EVM-compatible chains. Each entry in compatibleNetworkIds produces a new wallet on that network with the same address as the source. Per-network failures are reported individually in the response without aborting the whole call: a target network that is not key-compatible with the source wallet's network, or that the organization | walletId (string) required data: { . activateAllCompatibleNetworks (boolean) . compatibleNetworkIds (array) } (object) required |
| post_wallets_by_wallet_id_addresses | Permissions required: Create address This endpoint allows you to request an asynchronous provision of a signed deposit address for a given wallet. For UTXO-based wallets a new address will always be provisioned upon request. For account-based wallets only one address may be provisioned per wallet and subsequent attempts will return the previously provisioned address. Newly requested addresses may not be available for several minutes once requested. | walletId (string) required |
| post_transactions_withdrawal | Permissions required: Initiate withdrawals Identify the sending asset To initiate a withdrawal from a wallet to an external destination, you must identify which asset you'd like to withdraw funds from. Provide a source with id and type. Identify the receiving resource Choose a resource to receive the funds as the destination. This resource may belong to your organization wallet or another organization address, standing instruction. Permissions The provided API key mus | Api-Signature (string) required Api-Timestamp (integer) required data: { . amount (string) . assetParametersATOM (object) . assetParametersCosmos (object) . assetParametersExtra (object) . assetParametersFiatTrustedDestination (object) . assetParametersXLM (object) . assetParametersXRP (object) . assetType (string) . description (string) . destination (object) . idempotentId (string) . source (object) . useGasStation (boolean) . withdrawalAmlQuestionnaire (object) } (object) required |
| get_transfers | Permissions required: Transfer funds List transfers created by your API key. For a given vault, transfers on it created by other API keys in your organization are also included if your API key's Transfer and Read permissions both cover that vault. Filters You may optionally supply the following filters: - Set a date range by providing the startDate and/or endDate query parameters. If the date parameters are omitted, all transfers will be returned. - Specify a specific vault to re | vaultId (string) walletId (string) transferIds (array) startDate (string) endDate (string) afterId (string) limit (integer) statuses (array) |
| post_transfers | Permissions required: Transfer funds Identify the sending resource and asset To initiate a transfer between resources, you must identify which resource you'd like to transfer funds from and the asset type to transfer. Provide a source and assetType. Identify the receiving resource Choose a resource to receive the funds as the destination. This resource may belong to your organization or another organization that also custodies with Anchorage Digital, or it may also be an appr | Api-Signature (string) required Api-Timestamp (integer) required Api-Child-Control-Key (string) data: { . amount (string) . assetParametersATOM (object) . assetParametersCosmos (object) . assetParametersExtra (object) . assetParametersFiatTrustedDestination (object) . assetParametersXLM (object) . assetParametersXRP (object) . assetType (string) . deductFeeFromAmountIfSameType (boolean) . destination (object) . idempotentId (string) . source (object) . transferAmlQuestionnaire (object) . transferMemo (string) . useGasStation (boolean) } (object) required |
| get_transfers_by_transfer_id | Permissions required: Transfer funds Get transfer by ID. Restricted to transfers created by your API key, unless your API key's Transfer and Read permissions both cover the transfer's vault. NOTE: price and USD value information is recent but does not reflect real-time data. | transferId (string) required |
| delete_transfers_by_transfer_id | Permissions required: Transfer funds Cancel a transfer request. Transfer requests in the QUEUED state can always be cancelled. Transfer requests in the IN_PROGRESS state can sometimes be cancelled if the request has not been broadcast on the blockchain. Trying to cancel a request that cannot be cancelled will return a 409 Conflict error code. Transfers can only be canceled by the API key responsible for creating that transfer either created directly via CreateTransfer or indirectly via Execu | transferId (string) required Api-Signature (string) required Api-Timestamp (integer) required |
| get_asset_types | Permissions required: none List all of the supported asset types for your organization. Each asset type object includes the name of the asset ex. Bitcoin as well as the asset type ex. BTC, which usually corresponds to the asset's ticker symbol. Filters You may optionally supply the following filters: - Specify the asset types to filter the organization asset types. Multiple asset types should be separated by commas. For example: To filter a single asset type to only Bitcoin | assetTypes (array) assetFeatures (array) |
| get_vaults | Permissions required: Read vault activity List vault metadata including name, ID, description, and assets. NOTE: price and USD value information is recent but does not reflect real-time data. | afterId (string) limit (integer) |
| get_vaults_by_vault_id | Permissions required: Read vault activity Get vault by ID | vaultId (string) required |
| get_transactions | Permissions required: Read vault activity List all transactions for the vaults permissioned to your API key. You can retrieve metadata about your API key from the API Key tags/API-Key endpoints. NOTE: price and USD value information is recent but does not reflect real-time data. Filters You may optionally supply the following filters: - Set a date range by providing the startDate and/or endDate query parameters. The date refers to the end time of a transaction: when the transactio | vaultId (string) startDate (string) endDate (string) afterId (string) limit (integer) types (array) walletId (string) destinationAddress (string) |
| get_transactions_by_transaction_id | Permissions required: Read vault activity Get transaction by ID. | transactionId (string) required |
| post_transactions_by_transaction_id_reject | Permissions required: Reject Operations Reject an in-progress transaction. The caller's API key must hold the Reject Operations permission for the source vault. Operations already in a final state return 409 Conflict. Only withdrawals, transfers, delegations, and generic operations including bridge transactions can be rejected via this endpoint; rejecting any other operation type returns 409 Conflict. A transaction can only be rejected before it has been submitted for signing and broadcast t | transactionId (string) required |
| get_offchainvesting_schedules | Get all offchain vesting schedules for an organization. | afterId (string) limit (integer) |
| get_wallets_by_wallet_id_staking_rewards | Permissions required: Read vault activity Get wallet rewards details for the specified walletId. | walletId (string) required startDate (string) endDate (string) afterId (string) limit (integer) |
| get_wallets_by_wallet_id_staking_positions | Permissions required: Read vault activity Get wallet staking positions details for the specified walletId. | walletId (string) required afterId (string) limit (integer) transactionId (string) |
| post_transactions_stake | Permissions required: Initiate Staking and Unstaking Identify the sending asset To initiate a staking operation, you must identify which asset you'd like to stake funds from. Provide a source and assetType. Permissions The provided API key must be associated with a permission group section/Authentication-and-Security/Permission-Groups that has Initiate Staking and Unstaking permission for the sending vault. Additional Metadata You may provide a description with each | Api-Signature (string) required Api-Timestamp (integer) required data: { . amount (string) . assetType (string) . description (string) . idempotentId (string) . parameters (object) . source (object) } (object) required |
| post_transactions_unstake | Permissions required: Initiate Staking and Unstaking Identify the sending asset To initiate an unstake transaction, you must identify which asset you'd like to unstake funds from. Provide a source and assetType. Permissions The provided API key must be associated with a permission group section/Authentication-and-Security/Permission-Groups that has Initiate Staking and Unstaking permission for the sending vault. Additional Metadata You may provide a description with | Api-Signature (string) required Api-Timestamp (integer) required data: { . amount (string) . assetType (string) . description (string) . idempotentId (string) . isFullAmount (boolean) . source (object) . stakingPositionId (string) } (object) required |
| post_transactions_collect | Permissions required: Initiate Staking and Unstaking In staking, the 'collect' operation is the action of claiming inactive unstaked amount back to the available balance by moving them from the staking protocol or pool into a personal wallet. Once collected, these amounts are fully under wallet's owner control. NOTE: This endpoint is under development. | Api-Signature (string) required Api-Timestamp (integer) required data: { . amount (string) . assetType (string) . description (string) . idempotentId (string) . isFullAmount (boolean) . source (object) . stakingPositionId (string) } (object) required |
| post_transactions_consolidate_stake | Permissions required: Initiate Staking and Unstaking Consolidate a source staking position into a target staking position. Only supported for Ethereum 0x02 validators. | Api-Signature (string) required Api-Timestamp (integer) required data: { . assetType (string) . description (string) . idempotentId (string) . source (object) . sourceStakingPosition (string) . targetStakingPosition (string) } (object) required |
| get_delegation_addresses_by_asset_type | Permissions required: Initiate Staking and Unstaking Identify the sending asset To initiate an operation, you must identify which asset you'd like to view the delegation addresses for. Provide an assetType. Permissions The provided API key must be associated with a permission group section/Authentication-and-Security/Permission-Groups that has Initiate Staking and Unstaking permission for the sending vault. | assetType (string) required afterId (string) limit (integer) |
| post_transactions_wallet_by_wallet_id_position_by_position_id_stake_transfer | Permissions required: Initiate Staking and Unstaking and Initiate withdrawals Allows the user to transfer a staked position to another Organization within Anchorage. | walletId (string) required positionId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . destinationInfo } (object) required |
| get_wallets_by_wallet_id_virtual_accounts | Permissions required: Virtual accounts or Read vault activity List the virtual accounts open on a wallet. Closed virtual accounts are excluded. No signature is required for this read. | walletId (string) required customerId (string) afterId (string) limit (integer) |
| post_wallets_by_wallet_id_virtual_accounts | Permissions required: Virtual accounts Create a fiat virtual account for the wallet identified by walletId, linked to the customer identified by customerId. | walletId (string) required Api-Signature (string) required Api-Timestamp (integer) required data: { . customerId (string) . idempotentId (string) } (object) required |
| get_webhook_validation_key | Permissions required: Configure Webhooks Get key to validate webhook authenticity. | No parameters |
| get_webhook_event_types | Permissions required: Configure Webhooks List the available webhook event types that you can subscribe to. | afterId (string) limit (integer) |
| post_webhook_endpoints | Permissions required: Configure Webhooks Create a new endpoint where you would like to receive webhook notifications. | data (array) required |
| get_webhook_endpoints | Permissions required: Configure Webhooks List all of your webhook endpoints. | afterId (string) limit (integer) |
| get_webhook_endpoints_by_endpoint_id | Permissions required: Configure Webhooks Get the configuration details for an endpoint. | endpointId (string) required |
| patch_webhook_endpoints_by_endpoint_id | Permissions required: Configure Webhooks Update the configuration for an endpoint. | endpointId (string) required data: { . description (string) . publicKey (string) . subscriptions (array) . url (string) } (object) required |
| post_webhook_endpoints_by_endpoint_id_subscriptions | Permissions required: Configure Webhooks Subscribe to event types to receive notifications in a webhook endpoint. | endpointId (string) required data (array) required |
| get_webhook_endpoints_by_endpoint_id_subscriptions | Permissions required: Configure Webhooks List the subscriptions that you configured for a webhook endpoint. | endpointId (string) required afterId (string) limit (integer) |
| delete_webhook_endpoints_by_endpoint_id_subscriptions_by_event_type_id | Permissions required: Configure Webhooks Cancel a webhook subscription to stop receiving notifications for its event type in its webhook endpoint. | endpointId (string) required eventTypeId (string) required |
| custom | Call any endpoint of the connected service while reusing the connection auth. Pass the full URL as _url. Other reserved keys: _method, _query, _body, _headers. Remaining params flow naturally — empty → GET, non-empty → POST JSON body. | _url (string) required _method (string) _query (object) _body _headers (object) |
Webhook Events
This connector emits 27 events back to your workflow. To receive one, create a hook whose path is <connection-name>/<event> — the connection name you configured plus the event from the table below.
| Event | Description |
|---|---|
| deposit-pending-attribution | A deposit is confirmed on-chain and awaiting attribution; funds are not yet available. |
| deposit-attributed | A pending deposit was attributed and funds are available. |
| deposit-blocked | A deposit was blocked after attribution review. |
| transfer-initiated | A transfer request was created. |
| transfer-completed | A transfer was completed successfully. |
| transfer-failed | A transfer failed to complete. |
| transfer-cancelled | A transfer was cancelled. |
| withdrawal-initiated | A withdrawal request was created. |
| withdrawal-completed | A withdrawal was completed successfully. |
| withdrawal-failed | A withdrawal failed to complete. |
| withdrawal-rejected | A withdrawal was rejected by quorum approval. |
| withdrawal-cancelled | A withdrawal was cancelled. |
| transaction-completed | A transaction was completed. |
| transaction-failed | A transaction failed. |
| transaction-rejected | A transaction was rejected. |
| trade-completed | A trade was executed. |
| quote-expired | A trading quote expired. |
| order-filled | A trading order was filled. |
| order-cancelled | A trading order was cancelled. |
| settlement-completed | A trading settlement completed. |
| atlas-settlement-proposed | An Atlas settlement was proposed. |
| atlas-settlement-authorized | An Atlas settlement was authorized. |
| atlas-settlement-accepted | An Atlas settlement was accepted. |
| atlas-settlement-rejected | An Atlas settlement was rejected. |
| kyc-application-completed | A KYC application was completed. |
| kyc-application-approved | A KYC application was approved. |
| kyc-application-rejected | A KYC application was rejected. |