NEAR Protocol Tx API

openapi: 3.2.0
info:
  description: Low-latency indexed account, token, and public-key lookup APIs for wallets and explorers. Embedded portal clients may forward an optional `apiKey` query parameter, but the public FastNEAR API does not require it.
  title: FastNEAR accounts Tx API
  version: 3.0.3
servers:
- description: Mainnet
  url: https://api.fastnear.com
- description: Testnet
  url: https://test.api.fastnear.com
tags:
- name: Tx
paths:
  /tx:
    post:
      description: Queries status of a transaction by hash and returns the final transaction result.
      operationId: tx
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonRpcRequest_for_tx'
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonRpcResponse_for_RpcTransactionResponse_and_RpcTransactionError'
      tags:
      - Tx
components:
  schemas:
    VersionedDelegateActionPayload:
      description: 'Versions of the delegate action carried by `Action::DelegateV2`. New

        versions add a variant here rather than a new `Action` variant. The variant

        is part of the signed payload, so a signature can''t be ambiguous across

        versions.'
      oneOf:
      - additionalProperties: false
        properties:
          V2:
            $ref: '#/components/schemas/DelegateActionV2'
        required:
        - V2
        type: object
    InternalError:
      oneOf:
      - properties:
          info:
            properties:
              error_message:
                type: string
            required:
            - error_message
            type: object
          name:
            enum:
            - INTERNAL_ERROR
            type: string
        required:
        - name
        - info
        type: object
    UseGlobalContractAction:
      description: Use global contract action
      properties:
        contract_identifier:
          $ref: '#/components/schemas/GlobalContractIdentifier'
      required:
      - contract_identifier
      type: object
    TransferAction:
      properties:
        deposit:
          $ref: '#/components/schemas/NearToken'
      required:
      - deposit
      type: object
    DeleteAccountAction:
      properties:
        beneficiary_id:
          $ref: '#/components/schemas/AccountId'
      required:
      - beneficiary_id
      type: object
    NonDelegateAction:
      description: An Action that can be included in a transaction or receipt, excluding delegate actions. This type represents all possible action types except DelegateAction to prevent infinite recursion in meta-transactions.
      oneOf:
      - additionalProperties: false
        description: 'Create an (sub)account using a transaction `receiver_id` as an ID for

          a new account ID must pass validation rules described here

          <https://nomicon.io/DataStructures/Account>.'
        properties:
          CreateAccount:
            $ref: '#/components/schemas/CreateAccountAction'
        required:
        - CreateAccount
        type: object
      - additionalProperties: false
        description: Sets a Wasm code to a receiver_id
        properties:
          DeployContract:
            $ref: '#/components/schemas/DeployContractAction'
        required:
        - DeployContract
        type: object
      - additionalProperties: false
        properties:
          FunctionCall:
            $ref: '#/components/schemas/FunctionCallAction'
        required:
        - FunctionCall
        type: object
      - additionalProperties: false
        properties:
          Transfer:
            $ref: '#/components/schemas/TransferAction'
        required:
        - Transfer
        type: object
      - additionalProperties: false
        properties:
          Stake:
            $ref: '#/components/schemas/StakeAction'
        required:
        - Stake
        type: object
      - additionalProperties: false
        properties:
          AddKey:
            $ref: '#/components/schemas/AddKeyAction'
        required:
        - AddKey
        type: object
      - additionalProperties: false
        properties:
          DeleteKey:
            $ref: '#/components/schemas/DeleteKeyAction'
        required:
        - DeleteKey
        type: object
      - additionalProperties: false
        properties:
          DeleteAccount:
            $ref: '#/components/schemas/DeleteAccountAction'
        required:
        - DeleteAccount
        type: object
      - additionalProperties: false
        properties:
          DeployGlobalContract:
            $ref: '#/components/schemas/DeployGlobalContractAction'
        required:
        - DeployGlobalContract
        type: object
      - additionalProperties: false
        properties:
          UseGlobalContract:
            $ref: '#/components/schemas/UseGlobalContractAction'
        required:
        - UseGlobalContract
        type: object
      - additionalProperties: false
        properties:
          DeterministicStateInit:
            $ref: '#/components/schemas/DeterministicStateInitAction'
        required:
        - DeterministicStateInit
        type: object
      - additionalProperties: false
        properties:
          TransferToGasKey:
            $ref: '#/components/schemas/TransferToGasKeyAction'
        required:
        - TransferToGasKey
        type: object
      - additionalProperties: false
        properties:
          WithdrawFromGasKey:
            $ref: '#/components/schemas/WithdrawFromGasKeyAction'
        required:
        - WithdrawFromGasKey
        type: object
    CreateAccountAction:
      description: Create account action
      type: object
    DeployContractAction:
      description: Deploy contract action
      properties:
        code:
          description: WebAssembly binary
          type: string
      required:
      - code
      type: object
    GlobalContractIdentifierView:
      oneOf:
      - additionalProperties: false
        properties:
          hash:
            $ref: '#/components/schemas/CryptoHash'
        required:
        - hash
        type: object
      - additionalProperties: false
        properties:
          account_id:
            $ref: '#/components/schemas/AccountId'
        required:
        - account_id
        type: object
    StorageError:
      description: 'Errors which may occur during working with trie storages, storing

        trie values (trie nodes and state values) by their hashes.'
      oneOf:
      - description: Key-value db internal failure
        enum:
        - StorageInternalError
        type: string
      - additionalProperties: false
        description: Requested trie value by its hash which is missing in storage.
        properties:
          MissingTrieValue:
            $ref: '#/components/schemas/MissingTrieValue'
        required:
        - MissingTrieValue
        type: object
      - description: 'Found trie node which shouldn''t be part of state. Raised during

          validation of state sync parts where incorrect node was passed.

          TODO (#8997): consider including hash of trie node.'
        enum:
        - UnexpectedTrieValue
        type: string
      - additionalProperties: false
        description: 'Either invalid state or key-value db is corrupted.

          For PartialStorage it cannot be corrupted.

          Error message is unreliable and for debugging purposes only. It''s also probably ok to

          panic in every place that produces this error.

          We can check if db is corrupted by verifying everything in the state trie.'
        properties:
          StorageInconsistentState:
            type: string
        required:
        - StorageInconsistentState
        type: object
      - additionalProperties: false
        description: 'Flat storage error, meaning that it doesn''t support some block anymore.

          We guarantee that such block cannot become final, thus block processing

          must resume normally.'
        properties:
          FlatStorageBlockNotSupported:
            type: string
        required:
        - FlatStorageBlockNotSupported
        type: object
      - additionalProperties: false
        description: In-memory trie could not be loaded for some reason.
        properties:
          MemTrieLoadingError:
            type: string
        required:
        - MemTrieLoadingError
        type: object
    AccessKey:
      description: 'Access key provides limited access to an account. Each access key belongs to some account and

        is identified by a unique (within the account) public key. One account may have large number of

        access keys. Access keys allow to act on behalf of the account by restricting transactions

        that can be issued.

        `account_id,public_key` is a key in the state'
      properties:
        nonce:
          description: 'Nonce for this access key, used for tx nonce generation. When access key is created, nonce

            is set to `(block_height - 1) * 1e6` to avoid tx hash collision on access key re-creation.

            See <https://github.com/near/nearcore/issues/3779> for more details.'
          format: uint64
          minimum: 0
          type: integer
        permission:
          allOf:
          - $ref: '#/components/schemas/AccessKeyPermission'
          description: Defines permissions for this access key.
      required:
      - nonce
      - permission
      type: object
    RpcTransactionError:
      oneOf:
      - properties:
          info:
            type: object
          name:
            enum:
            - INVALID_TRANSACTION
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          name:
            enum:
            - DOES_NOT_TRACK_SHARD
            type: string
        required:
        - name
        type: object
      - properties:
          info:
            properties:
              transaction_hash:
                $ref: '#/components/schemas/CryptoHash'
            required:
            - transaction_hash
            type: object
          name:
            enum:
            - REQUEST_ROUTED
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          info:
            properties:
              requested_transaction_hash:
                $ref: '#/components/schemas/CryptoHash'
            required:
            - requested_transaction_hash
            type: object
          name:
            enum:
            - UNKNOWN_TRANSACTION
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          info:
            properties:
              debug_info:
                type: string
            required:
            - debug_info
            type: object
          name:
            enum:
            - INTERNAL_ERROR
            type: string
        required:
        - name
        - info
        type: object
      - properties:
          name:
            enum:
            - TIMEOUT_ERROR
            type: string
        required:
        - name
        type: object
    WithdrawFromGasKeyAction:
      description: 'Withdraw NEAR from a gas key''s balance to the account.


        This action must only be available via transactions, not via contract execution

        (there is no corresponding promise batch action host function).'
      properties:
        amount:
          allOf:
          - $ref: '#/components/schemas/NearToken'
          description: Amount of NEAR to transfer from the gas key
        public_key:
          allOf:
          - $ref: '#/components/schemas/PublicKey'
          description: The public key of the gas key to withdraw from
      required:
      - public_key
      - amount
      type: object
    ReceiptValidationError:
      description: Describes the error for validating a receipt.
      oneOf:
      - additionalProperties: false
        description: The `predecessor_id` of a Receipt is not valid.
        properties:
          InvalidPredecessorId:
            properties:
              account_id:
                type: string
            required:
            - account_id
            type: object
        required:
        - InvalidPredecessorId
        type: object
      - additionalProperties: false
        description: The `receiver_id` of a Receipt is not valid.
        properties:
          InvalidReceiverId:
            properties:
              account_id:
                type: string
            required:
            - account_id
            type: object
        required:
        - InvalidReceiverId
        type: object
      - additionalProperties: false
        description: The `signer_id` of an ActionReceipt is not valid.
        properties:
          InvalidSignerId:
            properties:
              account_id:
                type: string
            required:
            - account_id
            type: object
        required:
        - InvalidSignerId
        type: object
      - additionalProperties: false
        description: The `receiver_id` of a DataReceiver within an ActionReceipt is not valid.
        properties:
          InvalidDataReceiverId:
            properties:
              account_id:
                type: string
            required:
            - account_id
            type: object
        required:
        - InvalidDataReceiverId
        type: object
      - additionalProperties: false
        description: The length of the returned data exceeded the limit in a DataReceipt.
        properties:
          ReturnedValueLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - ReturnedValueLengthExceeded
        type: object
      - additionalProperties: false
        description: The number of input data dependencies exceeds the limit in an ActionReceipt.
        properties:
          NumberInputDataDependenciesExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              number_of_input_data_dependencies:
                format: uint64
                minimum: 0
                type: integer
            required:
            - number_of_input_data_dependencies
            - limit
            type: object
        required:
        - NumberInputDataDependenciesExceeded
        type: object
      - additionalProperties: false
        description: An error occurred while validating actions of an ActionReceipt.
        properties:
          ActionsValidation:
            $ref: '#/components/schemas/ActionsValidationError'
        required:
        - ActionsValidation
        type: object
      - additionalProperties: false
        description: Receipt is bigger than the limit.
        properties:
          ReceiptSizeExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              size:
                format: uint64
                minimum: 0
                type: integer
            required:
            - size
            - limit
            type: object
        required:
        - ReceiptSizeExceeded
        type: object
      - additionalProperties: false
        description: The `refund_to` of an ActionReceipt is not valid.
        properties:
          InvalidRefundTo:
            properties:
              account_id:
                type: string
            required:
            - account_id
            type: object
        required:
        - InvalidRefundTo
        type: object
    JsonRpcResponse_for_RpcTransactionResponse_and_RpcTransactionError:
      oneOf:
      - properties:
          result:
            $ref: '#/components/schemas/RpcTransactionResponse'
        required:
        - result
        type: object
      - properties:
          error:
            $ref: '#/components/schemas/ErrorWrapper_for_RpcTransactionError'
        required:
        - error
        type: object
      properties:
        id:
          type: string
        jsonrpc:
          type: string
      required:
      - jsonrpc
      - id
      title: JsonRpcResponse_for_RpcTransactionResponse_and_RpcTransactionError
      type: object
    NonceMode:
      description: Controls how the transaction nonce is validated against the access key nonce.
      oneOf:
      - description: Any nonce strictly greater than the current access key nonce (default behavior).
        enum:
        - monotonic
        type: string
      - description: Nonce must be exactly `ak_nonce + 1` (sequential ordering).
        enum:
        - strict
        type: string
    HostError:
      oneOf:
      - description: String encoding is bad UTF-16 sequence
        enum:
        - BadUTF16
        type: string
      - description: String encoding is bad UTF-8 sequence
        enum:
        - BadUTF8
        type: string
      - description: Exceeded the prepaid gas
        enum:
        - GasExceeded
        type: string
      - description: Exceeded the maximum amount of gas allowed to burn per contract
        enum:
        - GasLimitExceeded
        type: string
      - description: Exceeded the account balance
        enum:
        - BalanceExceeded
        type: string
      - description: Tried to call an empty method name
        enum:
        - EmptyMethodName
        type: string
      - additionalProperties: false
        description: Smart contract panicked
        properties:
          GuestPanic:
            properties:
              panic_msg:
                type: string
            required:
            - panic_msg
            type: object
        required:
        - GuestPanic
        type: object
      - description: IntegerOverflow happened during a contract execution
        enum:
        - IntegerOverflow
        type: string
      - additionalProperties: false
        description: '`promise_idx` does not correspond to existing promises'
        properties:
          InvalidPromiseIndex:
            properties:
              promise_idx:
                format: uint64
                minimum: 0
                type: integer
            required:
            - promise_idx
            type: object
        required:
        - InvalidPromiseIndex
        type: object
      - description: Actions can only be appended to non-joint promise.
        enum:
        - CannotAppendActionToJointPromise
        type: string
      - description: Returning joint promise is currently prohibited
        enum:
        - CannotReturnJointPromise
        type: string
      - additionalProperties: false
        description: Accessed invalid promise result index
        properties:
          InvalidPromiseResultIndex:
            properties:
              result_idx:
                format: uint64
                minimum: 0
                type: integer
            required:
            - result_idx
            type: object
        required:
        - InvalidPromiseResultIndex
        type: object
      - additionalProperties: false
        description: Accessed invalid register id
        properties:
          InvalidRegisterId:
            properties:
              register_id:
                format: uint64
                minimum: 0
                type: integer
            required:
            - register_id
            type: object
        required:
        - InvalidRegisterId
        type: object
      - additionalProperties: false
        description: Iterator `iterator_index` was invalidated after its creation by performing a mutable operation on trie
        properties:
          IteratorWasInvalidated:
            properties:
              iterator_index:
                format: uint64
                minimum: 0
                type: integer
            required:
            - iterator_index
            type: object
        required:
        - IteratorWasInvalidated
        type: object
      - description: Accessed memory outside the bounds
        enum:
        - MemoryAccessViolation
        type: string
      - additionalProperties: false
        description: VM Logic returned an invalid receipt index
        properties:
          InvalidReceiptIndex:
            properties:
              receipt_index:
                format: uint64
                minimum: 0
                type: integer
            required:
            - receipt_index
            type: object
        required:
        - InvalidReceiptIndex
        type: object
      - additionalProperties: false
        description: Iterator index `iterator_index` does not exist
        properties:
          InvalidIteratorIndex:
            properties:
              iterator_index:
                format: uint64
                minimum: 0
                type: integer
            required:
            - iterator_index
            type: object
        required:
        - InvalidIteratorIndex
        type: object
      - description: VM Logic returned an invalid account id
        enum:
        - InvalidAccountId
        type: string
      - description: VM Logic returned an invalid method name
        enum:
        - InvalidMethodName
        type: string
      - description: VM Logic provided an invalid public key
        enum:
        - InvalidPublicKey
        type: string
      - additionalProperties: false
        description: '`method_name` is not allowed in view calls'
        properties:
          ProhibitedInView:
            properties:
              method_name:
                type: string
            required:
            - method_name
            type: object
        required:
        - ProhibitedInView
        type: object
      - additionalProperties: false
        description: The total number of logs will exceed the limit.
        properties:
          NumberOfLogsExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - limit
            type: object
        required:
        - NumberOfLogsExceeded
        type: object
      - additionalProperties: false
        description: The storage key length exceeded the limit.
        properties:
          KeyLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - KeyLengthExceeded
        type: object
      - additionalProperties: false
        description: The storage value length exceeded the limit.
        properties:
          ValueLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - ValueLengthExceeded
        type: object
      - additionalProperties: false
        description: The total log length exceeded the limit.
        properties:
          TotalLogLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - TotalLogLengthExceeded
        type: object
      - additionalProperties: false
        description: The maximum number of promises within a FunctionCall exceeded the limit.
        properties:
          NumberPromisesExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              number_of_promises:
                format: uint64
                minimum: 0
                type: integer
            required:
            - number_of_promises
            - limit
            type: object
        required:
        - NumberPromisesExceeded
        type: object
      - additionalProperties: false
        description: The maximum number of input data dependencies exceeded the limit.
        properties:
          NumberInputDataDependenciesExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              number_of_input_data_dependencies:
                format: uint64
                minimum: 0
                type: integer
            required:
            - number_of_input_data_dependencies
            - limit
            type: object
        required:
        - NumberInputDataDependenciesExceeded
        type: object
      - additionalProperties: false
        description: The returned value length exceeded the limit.
        properties:
          ReturnedValueLengthExceeded:
            properties:
              length:
                format: uint64
                minimum: 0
                type: integer
              limit:
                format: uint64
                minimum: 0
                type: integer
            required:
            - length
            - limit
            type: object
        required:
        - ReturnedValueLengthExceeded
        type: object
      - additionalProperties: false
        description: The contract size for DeployContract action exceeded the limit.
        properties:
          ContractSizeExceeded:
            properties:
              limit:
                format: uint64
                minimum: 0
                type: integer
              size:
                format: uint64
                minimum: 0
                type: integer
            required:
            - size
            - limit
            type: object
        required:
        - ContractSizeExceeded
        type: object
      - additionalProperties: false
        description: The host function was deprecated.
        properties:
          Deprecated:
            properties:
              method_name:
                type: string
            required:
            - method_name
            type: object
        required:
        - Deprecated
        type: object
      - additionalProperties: false
        description: General errors for ECDSA recover.
        properties:
          ECRecoverError:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - ECRecoverError
        type: object
      - additionalProperties: false
        description: 'Invalid input to alt_bn128 family of functions (e.g., point which isn''t

          on the curve).'
        properties:
          AltBn128InvalidInput:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - AltBn128InvalidInput
        type: object
      - additionalProperties: false
        description: 'Invalid input to ed25519 signature verification function (e.g. signature cannot be

          derived from bytes).'
        properties:
          Ed25519VerifyInvalidInput:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - Ed25519VerifyInvalidInput
        type: object
      - additionalProperties: false
        description: 'Input length mismatch for p256 signature verification (signature is not 64

          bytes or public key is not 33 bytes). Parse failures of otherwise

          well-sized inputs return 0 from the host function instead of aborting.'
        properties:
          P256VerifyInvalidInput:
            properties:
              msg:
                type: string
            required:
            - msg
            type: object
        required:
        - P256VerifyInvalidInput
        type: object
    FunctionCallAction:
      properties:
        args:
          type: string
        deposit:
          $ref: '#/components/schemas/NearToken'
        gas:
          $ref: '#/components/schemas/NearGas'
        method_name:
          type: string
      required:
      - method_name
      - args
      - gas
      - deposit
      type: object
    FinalExecutionStatus:
      oneOf:
      - description: The execution has not yet started.
        enum:
        - NotStarted
        type: string
      - description: The execution has started and still going.
        enum:
        - Started
        type: string
      - additionalProperties: false
        description: The execution has failed with the given error.
        properties:
          Failure:
            $ref: '#/components/schemas/TxExecutionError'
        required:
        - Failure
        type: object
      - additionalProperties: false
        description: The execution has succeeded and returned some value or an empty vec encoded in base64.
        properties:
          SuccessValue:
            type: string
        required:
        - SuccessValue
        type: object
    GlobalContractDeployMode:
      oneOf:
      - description: 'Contract is deployed under its code hash.

          Users will be able reference it by that hash.

          This effectively makes the contract immutable.'
        enum:
        - CodeHash
        type: string
      - description: 'Contract is deployed under the owner account id.

          Users will be able reference it by that account id.

          This allows the owner to update the contract for all its users.'
        enum:
        - AccountId
        type: string
    ReceiptEnumView:
      oneOf:
      - additionalProperties: false
        properties:
          Action:
            properties:
              actions:
                items:
                  $ref: '#/components/schemas/ActionView'
                type: array
              gas_price:
                $ref: '#/components/schemas/NearToken'
              input_data_ids:
                items:
                  $ref: '#/components/schemas/CryptoHash'
                type: array
              is_promise_yield:
                default: false
                type: boolean
              output_data_receivers:
                items:
                  $ref: '#/components/schemas/DataReceiverView'
                type: array
              refund_to:
                anyOf:
                - $ref: '#/components/schemas/AccountId'
                - enum:
                  - null
              signer_id:
                $ref: '#/components/schemas/AccountId'
              signer_public_key:
                $ref: '#/components/schemas/PublicKey'
            required:
            - signer_id
            - signer_public_key
            - gas_price
            - output_data_receivers
            - input_data_ids
            - actions
            type: object
        required:
        - Action
        type: object
      - additionalProperties: false
        properties:
          Data:
            properties:
              data:
                default: null
                type:
                - string
                - 'null'
              data_id:
                $ref: '#/components/schemas/CryptoHash'
              is_promise_resume:
                default: false
                type: boolean
            required:
            - data_id
            type: object
        required:
        - Data
        type: object
      - additionalProperties: false
        properties:
          GlobalContractDistribution:
            properties:
              already_delivered_shards:
                items:
                  $ref: '#/components/schemas/ShardId'
                type: array
              code:
                type: string
              id:
                $ref: '#/components/schemas/GlobalContractIdentifier'
              nonce:
                format: uint64
        

# --- truncated at 32 KB (113 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/near/refs/heads/main/openapi/near-tx-api-openapi.yml