openapi: 3.1.0
info:
  title: Data AVAX Supply EVM Contracts API
  description: The Data API provides web3 application developers with multi-chain data related to Avalanche's primary network, Avalanche subnets, and Ethereum. With Data API, you can easily build products that leverage real-time and historical transaction and transfer history, native and token balances, and various types of token metadata. The API is in Beta and may be subject to change.</br></br>If you have feedback or feature requests for the API, please submit them <a href="https://portal.productboard.com/dndv9ahlkdfye4opdm8ksafi/tabs/4-glacier-api">here</a>. Bug reports can be submitted <a href="https://docs.google.com/forms/d/e/1FAIpQLSeJQrcp7QoNiqozMDKrVJGX5wpU827d3cVTgF8qa7t_J1Pb-g/viewform">here</a>, and any potential security issues can be reported <a href="https://immunefi.com/bounty/avalabs">here</a>.
  version: 1.0.0
  contact: {}
servers:
- url: https://glacier-api.avax.network
security:
- apiKey: []
- {}
tags:
- name: EVM Contracts
  description: Find information about contracts on EVM-compatible chains, such as the Avalanche C-Chain.
paths:
  /v1/chains/{chainId}/addresses/{address}:
    get:
      operationId: getContractMetadata
      x-speakeasy-name-override: getMetadata
      x-speakeasy-group: data.evm.contracts
      summary: Get contract metadata
      description: Gets metadata about the contract at the given address.
      parameters:
      - name: chainId
        required: true
        in: path
        description: A supported evm chain id or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
        example: '43114'
        schema:
          type: string
      - name: address
        required: true
        in: path
        description: Contract address on the relevant chain.
        example: '0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E'
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Erc721Contract'
                - $ref: '#/components/schemas/Erc1155Contract'
                - $ref: '#/components/schemas/Erc20Contract'
                - $ref: '#/components/schemas/UnknownContract'
                discriminator:
                  propertyName: ercType
                  mapping:
                    ERC-721: '#/components/schemas/Erc721Contract'
                    ERC-1155: '#/components/schemas/Erc1155Contract'
                    ERC-20: '#/components/schemas/Erc20Contract'
                    UNKNOWN: '#/components/schemas/UnknownContract'
        '400':
          description: "Bad requests generally mean the client has passed invalid \n    or malformed parameters. Error messages in the response could help in \n    evaluating the error."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequest'
        '401':
          description: "When a client attempts to access resources that require \n    authorization credentials but the client lacks proper authentication \n    in the request, the server responds with 401."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: "When a client attempts to access resources with valid\n    credentials but doesn't have the privilege to perform that action, \n    the server responds with 403."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Forbidden'
        '404':
          description: "The error is mostly returned when the client requests\n    with either mistyped URL, or the passed resource is moved or deleted, \n    or the resource doesn't exist."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFound'
        '429':
          description: "This error is returned when the client has sent too many,\n    and has hit the rate limit."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequests'
        '500':
          description: "The error is a generic server side error that is \n    returned for any uncaught and unexpected issues on the server side. \n    This should be very rare, and you may reach out to us if the problem \n    persists for a longer duration."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerError'
        '502':
          description: "This is an internal error indicating invalid response \n      received by the client-facing proxy or gateway from the upstream server."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadGateway'
        '503':
          description: "The error is returned for certain routes on a particular\n    Subnet. This indicates an internal problem with our Subnet node, and may \n    not necessarily mean the Subnet is down or affected."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceUnavailable'
      tags:
      - EVM Contracts
      x-codeSamples:
      - lang: javascript
        label: JavaScript
        source: "import { Avalanche } from \"@avalanche-sdk/chainkit\";\n\nconst avalanche = new Avalanche({\n  chainId: \"43114\",\n});\n\nasync function run() {\n  const result = await avalanche.data.evm.contracts.getMetadata({\n    address: \"0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E\",\n  });\n\n  console.log(result);\n}\n\nrun();"
components:
  schemas:
    InternalServerError:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 500
        error:
          type: string
          description: The type of error
          examples:
          - Internal Server Error
      required:
      - message
      - statusCode
      - error
    TooManyRequests:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 429
        error:
          type: string
          description: The type of error
          examples:
          - Too Many Requests
      required:
      - message
      - statusCode
      - error
    ImageAsset:
      type: object
      properties:
        assetId:
          type: string
        imageUri:
          type: string
          description: OUTPUT ONLY
    ResourceLinkType:
      type: string
      enum:
      - Blog
      - CoinGecko
      - CoinMarketCap
      - Discord
      - Documentation
      - Facebook
      - Github
      - Instagram
      - LinkedIn
      - Medium
      - Reddit
      - Support
      - Telegram
      - TikTok
      - Twitter
      - Website
      - Whitepaper
      - Youtube
    BadRequest:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 400
        error:
          type: string
          description: The type of error
          examples:
          - Bad Request
      required:
      - message
      - statusCode
      - error
    Erc20Contract:
      type: object
      properties:
        name:
          type: string
          description: The contract name.
          examples:
          - Wrapped AVAX
        description:
          type: string
        officialSite:
          type: string
        email:
          type: string
        logoAsset:
          $ref: '#/components/schemas/ImageAsset'
        bannerAsset:
          $ref: '#/components/schemas/ImageAsset'
        color:
          type: string
        resourceLinks:
          type: array
          items:
            $ref: '#/components/schemas/ResourceLink'
        tags:
          type: array
          items:
            type: string
        address:
          type: string
          description: A wallet or contract address in mixed-case checksum encoding.
          examples:
          - '0x71C7656EC7ab88b098defB751B7401B5f6d8976F'
        deploymentDetails:
          $ref: '#/components/schemas/ContractDeploymentDetails'
        ercType:
          type: string
          enum:
          - ERC-20
        symbol:
          type: string
          description: The contract symbol.
          examples:
          - WAVAX
        decimals:
          type: number
          description: The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
          examples:
          - 18
        pricingProviders:
          $ref: '#/components/schemas/PricingProviders'
      required:
      - address
      - ercType
      - decimals
    ServiceUnavailable:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 503
        error:
          type: string
          description: The type of error
          examples:
          - Service Unavailable
      required:
      - message
      - statusCode
      - error
    PricingProviders:
      type: object
      properties:
        coingeckoCoinId:
          type: string
    NotFound:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 404
        error:
          type: string
          description: The type of error
          examples:
          - Not Found
      required:
      - message
      - statusCode
      - error
    UnknownContract:
      type: object
      properties:
        name:
          type: string
          description: The contract name.
          examples:
          - Wrapped AVAX
        description:
          type: string
        officialSite:
          type: string
        email:
          type: string
        logoAsset:
          $ref: '#/components/schemas/ImageAsset'
        bannerAsset:
          $ref: '#/components/schemas/ImageAsset'
        color:
          type: string
        resourceLinks:
          type: array
          items:
            $ref: '#/components/schemas/ResourceLink'
        tags:
          type: array
          items:
            type: string
        address:
          type: string
          description: A wallet or contract address in mixed-case checksum encoding.
          examples:
          - '0x71C7656EC7ab88b098defB751B7401B5f6d8976F'
        deploymentDetails:
          $ref: '#/components/schemas/ContractDeploymentDetails'
        ercType:
          type: string
          enum:
          - UNKNOWN
      required:
      - address
      - ercType
    Erc721Contract:
      type: object
      properties:
        name:
          type: string
          description: The contract name.
          examples:
          - Wrapped AVAX
        description:
          type: string
        officialSite:
          type: string
        email:
          type: string
        logoAsset:
          $ref: '#/components/schemas/ImageAsset'
        bannerAsset:
          $ref: '#/components/schemas/ImageAsset'
        color:
          type: string
        resourceLinks:
          type: array
          items:
            $ref: '#/components/schemas/ResourceLink'
        tags:
          type: array
          items:
            type: string
        address:
          type: string
          description: A wallet or contract address in mixed-case checksum encoding.
          examples:
          - '0x71C7656EC7ab88b098defB751B7401B5f6d8976F'
        deploymentDetails:
          $ref: '#/components/schemas/ContractDeploymentDetails'
        ercType:
          type: string
          enum:
          - ERC-721
        symbol:
          type: string
          description: The contract symbol.
          examples:
          - WAVAX
      required:
      - address
      - ercType
    BadGateway:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 502
        error:
          type: string
          description: The type of error
          examples:
          - Bad Gateway
      required:
      - message
      - statusCode
      - error
    Forbidden:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 403
        error:
          type: string
          description: The type of error
          examples:
          - Forbidden
      required:
      - message
      - statusCode
      - error
    Erc1155Contract:
      type: object
      properties:
        name:
          type: string
          description: The contract name.
          examples:
          - Wrapped AVAX
        description:
          type: string
        officialSite:
          type: string
        email:
          type: string
        logoAsset:
          $ref: '#/components/schemas/ImageAsset'
        bannerAsset:
          $ref: '#/components/schemas/ImageAsset'
        color:
          type: string
        resourceLinks:
          type: array
          items:
            $ref: '#/components/schemas/ResourceLink'
        tags:
          type: array
          items:
            type: string
        address:
          type: string
          description: A wallet or contract address in mixed-case checksum encoding.
          examples:
          - '0x71C7656EC7ab88b098defB751B7401B5f6d8976F'
        deploymentDetails:
          $ref: '#/components/schemas/ContractDeploymentDetails'
        ercType:
          type: string
          enum:
          - ERC-1155
        symbol:
          type: string
          description: The contract symbol.
          examples:
          - WAVAX
        pricingProviders:
          $ref: '#/components/schemas/PricingProviders'
      required:
      - address
      - ercType
    ResourceLink:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ResourceLinkType'
        url:
          type: string
      required:
      - type
      - url
    Unauthorized:
      type: object
      properties:
        message:
          description: The error message describing the reason for the exception
          oneOf:
          - type: string
          - type: array
            items:
              type: string
        statusCode:
          type: number
          description: The HTTP status code of the response
          examples:
          - 401
        error:
          type: string
          description: The type of error
          examples:
          - Unauthorized
      required:
      - message
      - statusCode
      - error
    ContractDeploymentDetails:
      type: object
      properties:
        txHash:
          type: string
        deployerAddress:
          type: string
          description: The address that initiated the transaction which deployed this contract.
        deployerContractAddress:
          type: string
          description: The contract address which deployed this contract via smart contract. This field is only populated when the contract was deployed as part of smart contract execution.
      required:
      - txHash
      - deployerAddress
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-glacier-api-key
      description: Api keys provide higher access to rate limits. To obtain an api key, sign up for an account at https://avacloud.io/.
x-speakeasy-retries:
  strategy: backoff
  backoff:
    initialInterval: 500
    maxInterval: 60000
    maxElapsedTime: 120000
    exponent: 1.5
  statusCodes:
  - 5XX
  retryConnectionErrors: true
x-speakeasy-globals:
  parameters:
  - $ref: '#/components/parameters/GlobalParamChainId'
  - $ref: '#/components/parameters/GlobalParamNetwork'
x-execution-weight-values:
  free: 1
  large: 50
  medium: 20
  none: 0
  small: 10
  xl: 100
  xxl: 200
x-rpc-method-execution-weights:
  eth_accounts: free
  eth_blockNumber: small
  eth_call: small
  eth_coinbase: small
  eth_chainId: free
  eth_gasPrice: small
  eth_getBalance: small
  eth_getBlockByHash: small
  eth_getBlockByNumber: small
  eth_getBlockTransactionCountByNumber: medium
  eth_getCode: medium
  eth_getLogs: xxl
  eth_getStorageAt: medium
  eth_getTransactionByBlockNumberAndIndex: medium
  eth_getTransactionByHash: small
  eth_getTransactionCount: small
  eth_getTransactionReceipt: small
  eth_signTransaction: medium
  eth_sendTransaction: medium
  eth_sign: medium
  eth_sendRawTransaction: small
  eth_syncing: free
  net_listening: free
  net_peerCount: medium
  net_version: free
  web3_clientVersion: small
  web3_sha3: small
  eth_newPendingTransactionFilter: medium
  eth_maxPriorityFeePerGas: small
  eth_baseFee: small
  rpc_modules: free
  eth_getChainConfig: small
  eth_feeConfig: small
  eth_getActivePrecompilesAt: small
x-speakeasy-webhooks:
  security:
    type: signature
    headerName: x-signature
    signatureTextEncoding: base64
    algorithm: hmac-sha256