sdk_responses.yaml

eth_getLogs:
  allOf:
    - type: object
      properties:
        result:
          type: array
          description: 'Array of log objects, or an empty array if nothing has changed since last poll.'
          items:
            $ref: '#/log_object'
eth_blockNumber:
  allOf:
    - type: object
      description: Integer of the current block number the client is on.
      properties:
        result:
          type: string
          description: Integer of the current block number the client is on.
eth_block:
  allOf:
    - type: object
      properties:
        result:
          $ref: '#/block_object'
log_object:
  allOf:
    - $ref: '#/hash_number_transactionIndex'
    - type: object
      properties:
        address:
          type: string
          description: 20 Bytes - address from which this log originated.
        logIndex:
          type: string
          description: Integer of the log index position in the block. null when its pending log.
        data:
          type: string
          description: Contains one or more 32 Bytes non-indexed arguments of the log.
        removed:
          type: boolean
          description: 'true when the log was removed, due to a chain reorganization. false if its a valid log.'
        topics:
          type: array
          items:
            type: string
          description: 'Array of zero to four 32 Bytes DATA of indexed log arguments. In solidity: The first topic is the hash of the signature of the event (e.g. Deposit(address,bytes32,uint256)), except you declare the event with the anonymous specifier.'
        transactionHash:
          type: string
          description: Hash of the transactions this log was created from. null when its pending log.
block_object:
  allOf:
    - $ref: '#/nonce_hash'
    - type: object
      description: 'A block object with the following fields, or null when no block was found.'
      properties:
        number:
          type: string
          description: the block number. null when its pending block.
        parentHash:
          type: string
          description: 32 Bytes - hash of the parent block.
        sha3Uncles:
          type: string
          description: 32 Bytes - SHA3 of the uncles data in the block.
        logsBloom:
          type: string
          description: 256 Bytes - the bloom filter for the logs of the block. null when its pending block.
        transactionsRoot:
          type: string
          description: 32 Bytes - the root of the transaction trie of the block.
        stateRoot:
          type: string
          description: 32 Bytes - the root of the final state trie of the block.
        receiptsRoot:
          type: string
          description: 32 Bytes - the root of the receipts trie of the block.
        miner:
          type: string
          description: 20 Bytes - the address of the beneficiary to whom the mining rewards were given.
        difficulty:
          type: string
          description: integer of the difficulty for this block.
        totalDifficulty:
          type: string
          description: integer of the total difficulty of the chain until this block.
        extraData:
          type: string
          description: the "extra data" field of this block.
        size:
          type: string
          description: integer the size of this block in bytes.
        gasLimit:
          type: string
          description: the maximum gas allowed in this block.
        gasUsed:
          type: string
          description: the total used gas by all transactions in this block.
        timestamp:
          type: string
          description: the unix timestamp for when the block was collated.
        transactions:
          type: array
          items:
            type: string
          description: 'Array of transaction objects, or 32 Bytes transaction hashes depending on the last given parameter.'
        uncles:
          type: array
          items:
            type: string
          description: Array of uncle hashes.
common_response_fields:
  type: object
  properties:
    id:
      type: integer
    jsonrpc:
      type: string
hash_number_transactionIndex:
  type: object
  properties:
    blockHash:
      type: string
      description: 32 Bytes - hash of the block where this log was in. null when its pending. null when its pending log
    blockNumber:
      type: string
      description: The block number where this log was in. null when its pending. null when its pending log.
    transactionIndex:
      type: string
      description: Integer of the transactions index position log was created from. null when its pending log.
nonce_hash:
  type: object
  properties:
    nonce:
      type: string
      description: 8 Bytes - hash of the generated proof-of-work. null when its pending block.
    hash:
      type: string
      description: 32 Bytes - hash of the block. null when its pending block.
eth_getTransactionByHash:
  allOf:
    - type: object
      properties:
        result:
          description: 'A transaction object, or null when no transaction was found'
          $ref: '#/transaction_object'
transaction_object:
  allOf:
    - $ref: '#/hash_number_transactionIndex'
    - $ref: '#/nonce_hash'
    - type: object
      properties:
        from:
          type: string
          description: 20 Bytes - address of the sender
        gas:
          type: string
          description: gas provided by the sender
        gasPrice:
          type: string
          description: gas price provided by the sender in Wei
        input:
          type: string
          description: the data send along with the transaction
        r:
          type: string
          description: ECDSA signature r
        s:
          type: string
          description: ECDSA signature s
        to:
          type: string
          description: 20 Bytes - address of the receiver. null when it's a contract creation transaction
        v:
          type: string
          description: ECDSA recovery id
        value:
          type: string
          description: value transferred in Wei
transaction_receipt:
  description: 'A transaction receipt object, or null when no receipt was found'
  allOf:
    - $ref: '#/hash_number_transactionIndex'
    - type: object
      properties:
        transactionHash:
          type: string
          description: 32 Bytes - hash of the transaction
        from:
          type: string
          description: 20 Bytes - address of the sender
        to:
          type: string
          description: 20 Bytes - address of the receiver. null when its a contract creation transaction
        cumulativeGasUsed:
          type: string
          description: The total amount of gas used when this transaction was executed in the block.
        gasUsed:
          type: string
          description: The amount of gas used by this specific transaction alone
        contractAddress:
          type: string
          description: '20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null'
        logs:
          type: array
          description: 'Array of log objects, which this transaction generated'
          items:
            $ref: '#/log_object'
        logsBloom:
          type: string
          description: 256 Bytes - Bloom filter for light clients to quickly retrieve related logs
        root:
          type: string
          description: 32 bytes of post-transaction stateroot (pre Byzantium)
        status:
          type: integer
          description: Either 1 (success) or 0 (failure)
          enum:
            - 0
            - 1
        effectiveGasPrice:
          type: string
        type:
          type: string
transaction_receipts:
  description: 'A list of transaction receipts for each transaction in this block'
  allOf:
      - type: object
        properties:
          receipts:
            type: array
            items:
              type: object
              properties:
                transactionHash:
                  type: string
                  description: 32 Bytes - hash of the transaction
                from:
                  type: string
                  description: 20 Bytes - address of the sender
                to:
                  type: string
                  description: 20 Bytes - address of the receiver. null when its a contract creation transaction
                cumulativeGasUsed:
                  type: string
                  description: The total amount of gas used when this transaction was executed in the block.
                gasUsed:
                  type: string
                  description: The amount of gas used by this specific transaction alone
                contractAddress:
                  type: string
                  description: '20 Bytes - The contract address created, if the transaction was a contract creation, otherwise null'
                logs:
                  type: array
                  description: 'Array of log objects, which this transaction generated'
                  items:
                    $ref: '#/log_object'
                logsBloom:
                  type: string
                  description: 256 Bytes - Bloom filter for light clients to quickly retrieve related logs
                root:
                  type: string
                  description: 32 bytes of post-transaction stateroot (pre Byzantium)
                status:
                  type: integer
                  description: Either 1 (success) or 0 (failure)
                  enum:
                    - 0
                    - 1
                effectiveGasPrice:
                  type: string
                type:
                  type: string
eth_getTransactionReceipt:
  allOf:
    - type: object
      properties:
        result:
          $ref: '#/transaction_receipt'
eth_getBlockReceipts:
  allOf:
    - type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/transaction_receipt'
eth_cancelPrivateTransaction:
  allOf:
    - type: object
      properties:
        result:
          type: boolean
eth_getProof:
  allOf:
    - type: object
      properties:
        result:
          type: Object
          description: An account object
          properties:
            balance:
              type: string
              description: the balance of the account
            codeHash:
              type: string
              description: 32 Bytes - hash of the code of the account. For a simple Account without code it will return '0xc5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470'
            nonce:
              type: string
              description: nonce of the account.
            storageHash:
              type: string
              description: 32 Bytes - SHA3 of the StorageRoot. All storage will deliver a MerkleProof starting with this rootHash.
            accountProof:
              type: array
              items:
                type: string
              description: 'Array of rlp-serialized MerkleTree-Nodes, starting with the stateRoot-Node, following the path of the SHA3 (address) as key.'
            storageProof:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    description: the requested storage key
                  value:
                    type: string
                    description: the storage value
                  proof:
                    type: array
                    items:
                      type: string
                    description: 'Array of rlp-serialized MerkleTree-Nodes, starting with the storageHash-Node, following the path of the SHA3 (key) as path.'
findContractDeployerResponse:
  allOf:
    - type: object
      properties:
        deployerAddress:
          type: string
          description: The address of the contract deployer, if it is available.
        blockNumber: 
          type: number
          description: The block number the contract was deployed in. 
string_result_response:
  allOf:
    - type: object
      properties:
        result:
          type: string
any_result_response:
  allOf:
    - type: object
      properties:
        result:
          type: any
number_result_response:
  allOf:
    - type: object
      properties:
        result:
          type: number
eth_feeHistory:
  allOf:
    - type: object
      properties:
        result:
          type: object
          required:
            - OLDESTBLOCK
            - BASEFEEPERGAS
            - GASUSEDRATIO
          properties:
            OLDESTBLOCK:
              type: integer
              format: int64
              description: Lowest number block of the returned range.
            BASEFEEPERGAS:
              type: array
              description: 'An array of block base fees per gas. This includes the next block after the newest of the returned range, because this value can be derived from the newest block. Zeroes are returned for pre-EIP-1559 blocks.'
              items:
                type: string
            GASUSEDRATIO:
              type: array
              items:
                type: number
            REWARD:
              type: array
              items:
                type: array
                items:
                  type: string
net_version:
  allOf:
    - type: object
      properties:
        result:
          type: string
          description: 'The current network id. 1 - Ethereum Mainnet, 2 - Morden Testnet (deprecated), 3 - Ropsten Testnet, 4 - Rinkeby Testnet, 42 - Kovan Testnet,'
          enum:
            - '1'
            - '2'
            - '3'
            - '4'
            - '42'
eth_subscribe:
  type: object
  properties:
    jsonrpc:
      default: '2.0'
      type: string
      enum:
        - '2.0'
      description: Always '2.0'.
    method:
      type: string
      default: eth_subscription
      enum:
        - eth_subscription
      description: Always 'eth_subscription'.
    params:
      type: object
      properties:
        subscription:
          type: string
          description: The subscription ID returned by the eth_subscription call which created this subscription.
        result:
          description: An object whose contents vary depending on the type of subscription.
          oneOf:
            - $ref: '#/transaction_object'
            - type: string
            - $ref: '#/block_object'
            - $ref: '#/log_object'
            - type: object
              properties:
                syncing:
                  type: boolean
                status:
                  type: object
                  properties:
                    startingBlock:
                      type: integer
                    currentBlock:
                      type: integer
                    highestBlock:
                      type: integer
                    pulledStates:
                      type: integer
                    knownStates:
                      type: integer
alchemy_getTokenAllowance:
  allOf:
    - type: object
      properties:
        result:
          type: string
          description: The allowance amount.
alchemy_getTokenBalances:
  allOf:
    - type: object
      properties:
        result:
          type: object
          properties:
            address:
              type: string
              description: 'DATA, 20 Bytes - The address for which token balances were checked.'
            tokenBalances:
              type: array
              description: Array - returns an array of token balance objects. One of tokenBalance or error will be null.
              items:
                type: object
                properties:
                  contractAddress:
                    type: string
                  tokenBalance:
                    type: string
                  error:
                    type: string
alchemy_getTokenMetadata:
  allOf:
    - type: object
      properties:
        result:
          type: object
          properties:
            name:
              type: string
              description: String - The token's name. null if not defined in the contract and not available from other sources.
            symbol:
              type: string
              description: String - The token's symbol. null if not defined in the contract and not available from other sources.
            decimals:
              type: number
              description: Number - The number of decimals of the token. null if not defined in the contract and not available from other sources.
            logo:
              type: string
              description: String - URL of the token's logo image. null if not available.
trace_call:
  allOf:
    - type: object
      properties:
        result:
          $ref: '#/trace_block'
trace_block:
  type: object
  properties:
    output:
      type: string
    stateDiff:
      type: string
    trace:
      type: array
      items:
        type: object
        properties:
          action:
            $ref: '#/action_object'
          error:
            type: string
          subtraces:
            type: string
          traceAddress:
            type: array
            items:
              type: string
          type:
            type: string
    vmTrace:
      type: string
action_object:
  type: object
  properties:
    callType:
      type: string
    from:
      type: string
    gas:
      type: string
    input:
      type: string
    to:
      type: string
    value:
      type: string
trace_callMany:
  allOf:
    - type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/trace_block'
trace_filter:
  allOf:
    - type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/trace_filter_object'
trace_filter_object:
  type: object
  properties:
    action:
      $ref: '#/action_object'
    blockHash:
      type: string
    blockNumber:
      type: string
    result:
      type: object
      properties:
        gasUsed:
          type: string
        output:
          type: string
        subtraces:
          type: integer
        traceAddress:
          type: array
          items:
            type: string
        transactionHash:
          type: string
        transactionPosition:
          type: string
        type:
          type: string
trace_get_object:
  type: object
  properties:
    action:
      $ref: '#/action_object'
    blockHash:
      type: string
    blockNumber:
      type: string
    result:
      type: object
      properties:
        gasUsed:
          type: string
        output:
          type: string
    subtraces:
      type: integer
    traceAddress:
      type: array
      items:
        type: string
    transactionHash:
      type: string
    transactionPosition:
      type: string
    type:
      type: string
trace_get:
  allOf:
    - type: object
      properties:
        result:
          $ref: '#/trace_get_object'
trace_transaction:
  allOf:
    - type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/trace_get_object'
trace_replayBlockTransactions:
  allOf:
    - type: object
      properties:
        result:
          type: array
          items:
            allOf:
              - $ref: '#/trace_block'
              - type: object
                properties:
                  transactionHash:
                    type: string

# ===== Polygon API Responses ============
bor_getAuthor:
  allOf:
    - type: object
      properties:
        result:
          description: AUTHOR - address.
          type: string
bor_getCurrentValidators:
  allOf:
    - type: object
      properties:
        result:
          description: List of current validators.
          type: array
          items:
            type: object
            properties:
              ID:
                type: integer
              signer:
                type: string
              power:
                type: integer
              accum:
                type: integer
bor_getCurrentProposer:
  allOf:
    - type: object
      properties:
        result:
          description: AUTHOR - address.
          type: string
bor_getRootHash:
  allOf:
    - type: object
      properties:
        result:
          description: Hash
          type: string
eth_getSignersAtHash:
  allOf:
    - type: object
      properties:
        result:
          description: List of HASH.
          type: array
          items:
            type: string
eth_getTransactionReceiptsByBlock:
  allOf:
    - type: object
      properties:
        result:
          description: Array of transaction receipt objects.
          type: array
          items:
            $ref: '#/transaction_receipt'
eth_syncing:
  allOf:
    - type: object
      properties:
        result:
          description: An object with sync status data or FALSE, when not syncing.
          oneOf:
            - type: object
              properties:
                startingBlock:
                  type: string
                  description: 'The block at which the import started (will only be reset, after the sync reached his head).'
                currentBlock:
                  type: string
                  description: 'The current block, same as eth_blockNumber'
                highestBlock:
                  type: string
                  description: 'The estimated highest block.'
            - type: boolean
alchemy_getAssetTransfers:
  allOf:
    - type: object
      properties:
        result:
          type: object
          description: 'An object with the following fields.'
          properties:
            pageKey:
              type: string
              description: 'Uuid of next page of results (if exists, else blank).'
            transfers:
              type: array
              description: 'Array of objects - sorted in ascending order by block number, ties broken by category (external , internal, token transfers).'
              items:
                $ref: '#/transfer'
transfer:
  type: object
  properties:
    category:
      type: string
      description: "'external', 'internal', 'token', 'erc20', 'erc721', 'erc1155', 'specialnft' - label for the transfer."
    token:
      type: string
      description: "'includes 'erc20' and 'erc721' transfers."
    blockNum:
      type: string
      description: 'The block where the transfer occurred (hex string).'
    from:
      type: string
      description: 'From address of transfer (hex string).'
    to:
      type: string
      description: 'To address of transfer (hex string). null if contract creation.'
    value:
      type: string
      nullable: true
      description: 'Converted asset transfer value as a number (raw value divided by contract decimal). null if ERC721 transfer or contract decimal not available.'
    erc721TokenId:
      type: string
      nullable: true
      description: 'Raw ERC721 token id (hex string). null if not an ERC721 token transfer.'
    erc1155Metadata:
      type: string
      nullable: true
      description: 'A list of objects containing the ERC1155 tokenId (hex string) and value (hex string). null if not an ERC1155 transfer.'
    tokenId:
      type: string
      description: 'Token ID for ERC721 (or other NFT) tokens.'
    asset:
      type: string
      nullable: true
      description: "ETH or the token's symbol. null if not defined in the contract and not available from other sources."
    uniqueId:
      type: string
      description: 'A unique identifier for the transfer object.'
    hash:
      type: string
      description: 'Transaction hash (hex string).'
    rawContract:
      type: object
      properties:
        value:
          type: string
          nullable: true
          description: 'Raw transfer value (hex string). null if ERC721 or ERC1155 transfer.'
        address:
          type: string
          nullable: true
          description: 'Contract address (hex string). null if external or internal transfer.'
        decimal:
          type: string
          nullable: true
          description: 'Contract decimal (hex string). null if not defined in the contract and not available from other sources.'
    metadata:
      type: object
      properties:
        blockTimestamp:
          type: string
          description: 'Timestamp of the block from which the transaction event originated (ISO-formatted timestamp).'
debug_traceTransaction:
  type: object
  properties:
    gas:
      type: integer
      format: int32
    returnValue:
      type: string
    structLogs:
      type: array
      items:
        type: object
        properties:
          depth:
            type: integer
            description: 'The execution depth'
          error:
            type: string
            description: 'If an error occurred, information about the error.'
          gas:
            type: integer
            description: 'Number, the amount of gas remaining.'
          gasCost:
            type: integer
            description: 'Number, the cost in wei of each unit of gas.'
          memory:
            type: object
            nullable: true
            description: "Object, a structure representing the contract's memory space"
          op:
            type: object
            description: 'Object, an OpCode object representing the current opcode.'
          pc:
            type: integer
            description: 'Number, the current program counter.'
          stack:
            type: array
            items:
              type: string
            description: 'Array[big.Int], the EVM execution stack.'
          storage:
            type: object
getFeeData:
  allOf:
    - type: object
      properties:
        maxFeePerGas:
          type: number
          description: BigNumber - The maxFeePerGas to use for a transaction. This is based on the most recent block's baseFee.
        maxPriorityFeePerGas:
          type: number
          description: BigNumber - The maxPriorityFeePerGas to use for a transaction. This accounts for the uncle risk and for the majority of current MEV risk.
        gasPrice:
          type: number
          description: BigNumber - The gasPrice to use for legacy transactions or networks which do not support EIP-1559.
sendTransaction: 
  allOf: 
    - type: object
      properties: 
        to:
          type: string
          description: To address of transfer (hex string).
        from: 
          type: string
          description: From address of transfer (hex string).
        nonce: 
          type: number
          description: Returns the number of transactions address has ever sent

        gasLimit:
          type: string
          description: The maximum gas allowed in this block.

        gasPrice:
          type: string
          description: Gas price provided by the sender in Wei

        data: 
          type: string
        value: 
          type: number
        chainId: 
          type: number

        type: 
          type: number
        accessList: 
          type: array

        maxFeePerGas:
          type: number
          description: BigNumber - The maxFeePerGas to use for a transaction. This is based on the most recent block's baseFee.
        maxPriorityFeePerGas:
          type: number
          description: BigNumber - The maxPriorityFeePerGas to use for a transaction. This accounts for the uncle risk and for the majority of current MEV risk.

        customData: 
          type: array
        ccipReadEnabled: 
          type: boolean