Anchorage Digital Asset Types API

openapi: 3.2.0
info:
  version: 2.0.0
  title: Anchorage Digital API Reference Asset Types API
  contact:
    email: api@anchorage.com
  description: '# Introduction

    *CONFIDENTIAL: Please do not distribute this documentation externally without prior Anchorage Digital approval.*


    The Anchorage Digital REST API v2.0 provides a set of operations and resources that allow Anchorage Digital clients and partners to:

    - Programmatically transfer funds from an Anchorage Digital vault or wallet without human intervention

    - Create and list deposit addresses in a vault

    - Read and monitor vault balances

    - Query transaction history including deposits

    …'
servers:
- url: https://api.anchorage-staging.com/v2
security:
- Api-Access-Key: []
tags:
- description: Descriptions of supported asset types
  name: Asset Types
paths:
  /asset-types:
    get:
      operationId: getAssetTypes
      summary: List supported asset types
      description: '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 we can use /v2/asset-types?assetTypes=BTC


        To filter multiple asset types for instance Bitcoin and Ethereum we could use /v2/asset-types?assetTypes=BTC,ETH


        - Specify the `feature types` to filter the organization asset types. Multiple features should be separated by commas.


        For example:


        To filter all organization assets that have the HOLD feature we can use /v2/asset-types?assetFeatures=HOLDS


        To filter all organization assets that have the HOLD or TRANSFERS feature we can use /v2/asset-types?assetFeatures=HOLDS,TRANSFERS'
      parameters:
      - name: assetTypes
        in: query
        description: 'The asset type IDs to be used as filter for the organization asset types.


          An asset type is considering to be passing this filter, if this set is not empty.

          '
        schema:
          type: array
          items:
            type: string
          uniqueItems: true
        explode: false
        style: form
      - name: assetFeatures
        in: query
        description: 'The asset features to be used as filter for the organization asset types.


          An asset type is considering to be passing this filter, if this set is not empty, and at least one of the features is supported by the asset type.

          '
        schema:
          type: array
          items:
            type: string
            enum:
            - TRANSFERS
            - HOLDS
          uniqueItems: true
        explode: false
        style: form
      responses:
        '200':
          description: List of supported asset types for your organization
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetTypesResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetails'
      tags:
      - Asset Types
      x-security:
        None: present
components:
  schemas:
    AssetTypeDetails:
      description: A representation of the details a given crypto-asset
      type: object
      properties:
        assetType:
          description: 'A string representing a type of crypto-asset, which usually corresponds to the crypto asset''s ticker symbol.


            Use `/asset-types` to list all of the supported asset types for your organization.

            '
          type: string
          example: BTC
        compatibleNetworkIds:
          description: Network IDs that share wallet key derivation with this asset's `networkId` and are enabled for your organization — the set valid to pass to the wallet activate and create endpoints. Empty when the network shares addresses with no other network. Excludes the asset's own `networkId`.
          type: array
          items:
            type: string
          example:
          - POLYGON
          - ARBITRUM
          - BASE
        decimals:
          description: The number of decimal places used to represent amounts of this asset type
          type: integer
          example: 8
        featureSupport:
          description: A list describing units of API functionality supported by this asset type
          type: array
          items:
            $ref: '#/components/schemas/SupportedFeature'
        name:
          description: A string representing the human-readable name of a crypto-asset.
          type: string
          example: Bitcoin
        networkId:
          description: The ID of the network for the given crypto-asset.
          type: string
          example: BTC
        onchainIdentifier:
          description: 'The onchain identifier for the given crypto-asset (for example, the contract address for ERC20 tokens). This value will omitted for native crypto-assets (ex: ETH, BTC, etc).'
          type: string
          example: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
      required:
      - assetType
      - name
      - decimals
      - featureSupport
      title: AssetTypeDetails
    AssetTypesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AssetTypeDetails'
          example:
          - assetType: BTC
            name: Bitcoin
            decimals: 8
            featureSupport:
            - TRANSFERS
            - HOLDS
            networkId: BTC
          - assetType: ETH
            name: Ethereum
            decimals: 18
            featureSupport:
            - TRANSFERS
            - HOLDS
            networkId: ETH
          - assetType: USDC
            name: USD Coin
            decimals: 6
            featureSupport:
            - TRANSFERS
            - HOLDS
            networkId: ETH
      required:
      - data
      title: AssetTypesResponse
    SupportedFeature:
      description: A string describing a particular unit of API functionality
      type: string
      enum:
      - TRANSFERS
      - HOLDS
      title: SupportedFeature
    ErrorType:
      description: The type of error returned.
      type: string
      enum:
      - InternalError
      - InvalidRequest
      - Unauthenticated
      - Forbidden
      - NotFound
      - Conflict
      - UnprocessableEntity
      - TooManyRequests
      - ServiceUnavailable
      - QuoteExpired
      - InsufficientFunds
      - NotImplemented
      title: ErrorType
    ErrorDetails:
      type: object
      properties:
        errorType:
          $ref: '#/components/schemas/ErrorType'
        message:
          description: A human-readable message providing more details about the error.
          type: string
          example: Missing required field 'amount'.
      required:
      - errorType
      - message
      title: ErrorDetails
  securitySchemes:
    Api-Access-Key:
      type: apiKey
      name: Api-Access-Key
      in: header
      description: An API key associated with a security role
x-tagGroups:
- name: Under Development
  tags:
  - Collateral Management
  - Holds
  - Deposit Attribution
  - Onboarding
  - Trusted Destinations
  - Atlas Settlement Network
  - Tax
- name: API Endpoints
  tags:
  - Addresses
  - Asset Types
  - Transactions
  - Transfers
  - Wallets
  - Vaults
  - Vesting
  - Tagging
  - Subaccounts
  - Stablecoins
  - Webhook Notifications
  - API Key
  - Statements
  - Tax Reporting
  - Trading
- name: Models
  tags:
  - Transfer Model
  - Transaction Model
  - Vault Model
  - Deposit Attribution Model