Chainstack TRON Node API

Chainstack-managed TRON full and Solidity nodes with 150+ documented HTTP API methods.

OpenAPI Specification

chainstack-tron-node-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Chainstack TRON Node API
  version: 1.0.0
  description: Chainstack-managed RPC node API for the TRON blockchain. Endpoints follow the canonical JSON-RPC over HTTPS
    interface for the network. Authenticate against your Chainstack node's per-node URL (e.g. https://nd-XXX-XXX-XXX.p2pify.com/<key>).
    Merged from the Chainstack Developer Portal per-method fragments at https://github.com/chainstack/dev-portal/tree/main/openapi/tron_node_api.
  contact:
    name: Chainstack API Support
    email: [email protected]
  license:
    name: Chainstack Terms
    url: https://chainstack.com/terms-of-service/
servers:
- url: https://{node_id}.p2pify.com/{api_key}
  description: Chainstack-managed node endpoint
  variables:
    node_id:
      default: nd-000-000-000
      description: Your Chainstack node identifier
    api_key:
      default: <api-key>
      description: Per-node access key
tags:
- name: General
paths:
  /accountpermissionupdate:
    post:
      tags:
      - General
      summary: Wallet/Accountpermissionupdate
      operationId: accountPermissionUpdate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - owner_address
              properties:
                owner_address:
                  type: string
                  default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                owner:
                  type: object
                  properties:
                    type:
                      type: integer
                      default: 0
                    permission_name:
                      type: string
                      default: owner
                    threshold:
                      type: integer
                      default: 1
                    keys:
                      type: array
                      items:
                        type: object
                        properties:
                          address:
                            type: string
                            default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                          weight:
                            type: integer
                            default: 1
                      default:
                      - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                        weight: 1
                witness:
                  type: object
                  properties:
                    type:
                      type: integer
                      default: 1
                    permission_name:
                      type: string
                      default: witness
                    threshold:
                      type: integer
                      default: 1
                    keys:
                      type: array
                      items:
                        type: object
                        properties:
                          address:
                            type: string
                            default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                          weight:
                            type: integer
                            default: 1
                      default:
                      - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                        weight: 1
                actives:
                  type: array
                  items:
                    type: object
                    properties:
                      type:
                        type: integer
                        default: 2
                      permission_name:
                        type: string
                        default: active
                      threshold:
                        type: integer
                        default: 1
                      operations:
                        type: string
                        description: 32-byte hex bitmask of allowed operations
                        default: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
                      keys:
                        type: array
                        items:
                          type: object
                          properties:
                            address:
                              type: string
                              default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                            weight:
                              type: integer
                              default: 1
                        default:
                        - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                          weight: 1
                  default:
                  - type: 2
                    permission_name: active
                    threshold: 1
                    operations: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF
                    keys:
                    - address: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                      weight: 1
                visible:
                  type: boolean
                  default: true
      responses:
        '200':
          description: Unsigned account permission update transaction
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                  txID:
                    type: string
                  raw_data:
                    type: object
                  raw_data_hex:
                    type: string
  /broadcasthex:
    post:
      tags:
      - General
      summary: Wallet/Broadcasthex
      operationId: broadcastHex
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                transaction:
                  type: string
                  description: The transaction data in hexadecimal format
              required:
              - transaction
              example:
                transaction: 0a84010a025e4b220847c9dc89341b300d40f8fed3a2a72e5a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a1541608f8da72479edc7dd921e4c30bb7e7cddbe722e121541e9d79cc47518930bc322d9bf7cddd260a0260a8d18e8077093afd0a2a72e1241deadbeefcafebabefacec0011234abcd0badf00d9999777755553333222211114321dcba0f0ff0f013579bdf2468ace0987654321a2b3c4d5e6f7a8b9c0deeff1b
      responses:
        '200':
          description: Transaction broadcast result
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                    description: Whether the broadcast was successful
                  txid:
                    type: string
                    description: Transaction ID if successful
                  message:
                    type: string
                    description: Status message
  /broadcasttransaction:
    post:
      tags:
      - General
      summary: Wallet/Broadcasttransaction
      operationId: broadcastTransaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - raw_data
              - raw_data_hex
              properties:
                raw_data:
                  type: object
                  default:
                    contract:
                    - parameter:
                        value:
                          amount: 1000
                          owner_address: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e
                          to_address: 41e9d79cc47518930bc322d9bf7cddd260a0260a8d
                        type_url: type.googleapis.com/protocol.TransferContract
                      type: TransferContract
                    ref_block_bytes: 5e4b
                    ref_block_hash: 47c9dc89341b300d
                    expiration: 1591089627000
                    timestamp: 1591089567635
                raw_data_hex:
                  type: string
                  default: 0a025e4b220847c9dc89341b300d40f8fed3a2a72e5a66080112620a2d747970652e676f6f676c65617069732e636f6d2f70726f746f636f6c2e5472616e73666572436f6e747261637412310a1541608f8da72479edc7dd921e4c30bb7e7cddbe722e121541e9d79cc47518930bc322d9bf7cddd260a0260a8d18e8077093afd0a2a72e
                signature:
                  type: array
                  description: Array of hex-encoded signatures (65-byte secp256k1).
                  items:
                    type: string
                  default:
                  - deadbeefcafebabefacec0011234abcd0badf00d9999777755553333222211114321dcba0f0ff0f013579bdf2468ace0987654321a2b3c4d5e6f7a8b9c0deeff1b
                visible:
                  type: boolean
                  default: false
      responses:
        '200':
          description: Transaction broadcast result
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: boolean
                  code:
                    type: string
                  message:
                    type: string
                  txid:
                    type: string
  /cancelallunfreezev2:
    post:
      tags:
      - General
      summary: Wallet/Cancelallunfreezev2
      operationId: cancelAllUnfreezeV2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - owner_address
              properties:
                owner_address:
                  type: string
                  default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                visible:
                  type: boolean
                  default: true
      responses:
        '200':
          description: Unsigned cancel all unfreeze transaction
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                  txID:
                    type: string
                  raw_data:
                    type: object
                  raw_data_hex:
                    type: string
  /clearabi:
    post:
      tags:
      - General
      summary: Wallet/Clearabi
      operationId: clearAbi
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                owner_address:
                  type: string
                  description: Address of the contract owner
                contract_address:
                  type: string
                  description: Address of the smart contract
                visible:
                  type: boolean
                  description: Whether to use visible (Base58) address format
              required:
              - owner_address
              - contract_address
              example:
                owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC
                contract_address: TR7NHqjeKQxGTCi8q8ZY4pL8otSzgjLj6t
                visible: true
      responses:
        '200':
          description: Contract ABI clearing transaction
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                    description: Whether addresses are in visible format
                  txID:
                    type: string
                    description: Transaction ID for the ABI clearing
                  raw_data:
                    type: object
                    properties:
                      contract:
                        type: array
                        description: Contract ABI clearing details
                      ref_block_bytes:
                        type: string
                        description: Reference block bytes
                      ref_block_hash:
                        type: string
                        description: Reference block hash
                      expiration:
                        type: number
                        description: Transaction expiration timestamp
                      timestamp:
                        type: number
                        description: Transaction creation timestamp
                  raw_data_hex:
                    type: string
                    description: Raw transaction data in hex format
  /createaccount:
    post:
      tags:
      - General
      summary: Wallet/Createaccount
      operationId: createAccount
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - owner_address
              - account_address
              properties:
                owner_address:
                  type: string
                  description: The existing account that pays the account creation fee. Must have sufficient TRX.
                  default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                account_address:
                  type: string
                  description: The new account address to be activated.
                  default: TFgY1uN8buRxAtV2r6Zy5sG3ACko6pJT1y
                visible:
                  type: boolean
                  description: When true, addresses are base58; when false, hex.
                  default: true
      responses:
        '200':
          description: Unsigned account creation transaction
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                  txID:
                    type: string
                  raw_data:
                    type: object
                  raw_data_hex:
                    type: string
        '400':
          description: Validation error (e.g., insufficient fee)
          content:
            application/json:
              schema:
                type: object
                properties:
                  Error:
                    type: string
              example:
                Error: 'class org.tron.core.exception.ContractValidateException : Validate CreateAccountActuator error, insufficient
                  fee.'
  /createassetissue:
    post:
      tags:
      - General
      summary: Wallet/Createassetissue
      operationId: createAssetIssue
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - owner_address
              - name
              - abbr
              - total_supply
              - trx_num
              - num
              - start_time
              - end_time
              - description
              - url
              properties:
                owner_address:
                  type: string
                  description: Address that will issue the token
                  default: TZ4UXDV5ZhNW7fb2AMSbgfAEZ7hWsnYS2g
                name:
                  type: string
                  description: Token name
                  default: MyToken
                abbr:
                  type: string
                  description: Token symbol/abbreviation
                  default: MTK
                total_supply:
                  type: integer
                  description: Total supply of tokens
                  default: 1000000000000
                trx_num:
                  type: integer
                  description: TRX amount for exchange rate
                  default: 1
                num:
                  type: integer
                  description: Token amount for exchange rate
                  default: 1000
                precision:
                  type: integer
                  description: Token decimal places (0-6)
                  default: 6
                start_time:
                  type: integer
                  description: ICO start time (timestamp)
                  default: 1640995200000
                end_time:
                  type: integer
                  description: ICO end time (timestamp)
                  default: 1672531200000
                description:
                  type: string
                  description: Token description
                  default: A new TRC10 token for the TRON ecosystem
                url:
                  type: string
                  description: Token project website
                  default: https://example.com
                free_asset_net_limit:
                  type: integer
                  description: Free bandwidth for token operations
                  default: 1000000
                public_free_asset_net_limit:
                  type: integer
                  description: Public free bandwidth limit
                  default: 1000000
                frozen_supply:
                  type: array
                  description: Frozen supply configurations
                  items:
                    type: object
                    properties:
                      frozen_amount:
                        type: integer
                      frozen_days:
                        type: integer
                visible:
                  type: boolean
                  description: Use base58 address format
                  default: true
      responses:
        '200':
          description: Unsigned TRC10 asset issue transaction
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                    description: Address format indicator
                  txID:
                    type: string
                    description: Transaction hash
                  raw_data:
                    type: object
                    description: Raw transaction data
                    properties:
                      contract:
                        type: array
                        description: Contract array
                      ref_block_bytes:
                        type: string
                        description: Reference block bytes
                      ref_block_hash:
                        type: string
                        description: Reference block hash
                      expiration:
                        type: number
                        description: Transaction expiration timestamp
                      timestamp:
                        type: number
                        description: Transaction creation timestamp
                      fee_limit:
                        type: number
                        description: Maximum fee allowed
                  raw_data_hex:
                    type: string
                    description: Hexadecimal raw transaction
  /createshieldedcontractparameters:
    post:
      tags:
      - General
      summary: Wallet/Createshieldedcontractparameters
      operationId: createShieldedContractParameters
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - spend_authority_signature
              - view_signature
              - proof_generation_key
              - payment_address
              - rcm
              - ar
              - alpha
              - rsk
              - ask
              properties:
                spend_authority_signature:
                  type: string
                  description: Spending authority signature (128 hex characters, no 0x prefix)
                  example: 08a1b2c3d4e5f6789012345678901234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
                view_signature:
                  type: string
                  description: View signature component (64 hex characters, no 0x prefix)
                  example: 1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b
                proof_generation_key:
                  type: string
                  description: Proof generation key (64 hex characters, no 0x prefix)
                  example: 2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3
                payment_address:
                  type: string
                  description: Recipient's shielded payment address (ztron1 format, 78 characters)
                  example: ztron1768kf7dy4qquefp46szk978d65eeua66yhr4zv260c0uzj68t3tfjl3en9lhyyfxalv4jus30xs
                rcm:
                  type: string
                  description: Randomness commitment value (64 hex characters, no 0x prefix)
                  example: 3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4
                ar:
                  type: string
                  description: Authentication randomness value (64 hex characters, no 0x prefix)
                  example: 4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5
                alpha:
                  type: string
                  description: Alpha parameter for proof generation (64 hex characters, no 0x prefix)
                  example: 5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6
                rsk:
                  type: string
                  description: Randomness for spending key (64 hex characters, no 0x prefix)
                  example: 6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7
                ask:
                  type: string
                  description: Authentication secret key (64 hex characters, no 0x prefix)
                  example: 7a8b9c0d1e2f3a4b5c6d7e8f9a0b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8
      responses:
        '200':
          description: Successfully created shielded contract parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  receive_description:
                    type: object
                    description: Receive description for shielded transaction
                  spend_description:
                    type: object
                    description: Spend description for shielded transaction
                  binding_signature:
                    type: string
                    description: Binding signature for transaction
  /createshieldedcontractparameterswithoutask:
    post:
      tags:
      - General
      summary: Wallet/Createshieldedcontractparameterswithoutask
      operationId: createShieldedContractParametersWithoutAsk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ovk
              - from_address
              - to_address
              - amount
              properties:
                ovk:
                  type: string
                  description: Outgoing viewing key (64 hex characters, no 0x prefix)
                  example: 09b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a0b1
                from_address:
                  type: string
                  description: Sender's shielded address
                  example: ztron1a2b3c4d5e6f7g8h9j0k1l2m3n4p5q6r7s8t9u0v1w2x3y4z5a6b7c8d9e0f1g2h3j4k5l6m7n8p9
                to_address:
                  type: string
                  description: Recipient's shielded address
                  example: ztron1z9y8x7w6v5u4t3s2r1q0p9n8m7l6k5j4h3g2f1e0d9c8b7a6z5y4x3w2v1u0t9s8r7q6p5n4m3
                amount:
                  type: string
                  description: Amount to transfer
                  example: '1000000'
                transparent_from_address:
                  type: string
                  description: Optional transparent sender address
                  example: TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE
                transparent_to_address:
                  type: string
                  description: Optional transparent recipient address
                  example: TXYZoPYKcJJvXWc2WqJcqWvHqCqvqP5h3X
      responses:
        '200':
          description: Successfully created shielded contract parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  receive_description:
                    type: object
                    description: Receive description for shielded transaction
                  spend_description:
                    type: object
                    description: Spend description for shielded transaction
                  binding_signature:
                    type: string
                    description: Binding signature for transaction
  /createspendauthsig:
    post:
      tags:
      - General
      summary: Wallet/Createspendauthsig
      operationId: createSpendAuthSig
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - ask
              - alpha
              - tx_hash
              properties:
                ask:
                  type: string
                  description: Authentication secret key for signing (32 bytes, hex without 0x prefix)
                  example: 0f63eabdfe2bbfe08012f6bb2db024e6809c16e8ed055aa41a6095424f192005
                alpha:
                  type: string
                  description: Alpha parameter for randomization (32 bytes, hex without 0x prefix)
                  example: d0f0768664f5c807f9e70d05993f029c71da529afaa5c037b44c63d6e13bc907
                tx_hash:
                  type: string
                  description: Transaction hash being authorized (32 bytes, hex without 0x prefix)
                  example: 7fb99e66df052f430d50e80a3f197c319a4e35184ed48a433d6219e025741337
      responses:
        '200':
          description: Successfully created spending authorization signature
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: string
                    description: Generated spending authorization signature (hex string without 0x prefix)
                    example: 66c806bc592a7599e65833bf25c3c7005c8b21b7895dd835a84c97d7bec49d0f1493d2c73a68eeb9b9699b92cae42406f9e44ebe19acaea3d5febfe28de57109
  /createtransaction:
    post:
      tags:
      - General
      summary: Wallet/Createtransaction
      operationId: createTransaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - to_address
              - owner_address
              - amount
              properties:
                to_address:
                  type: string
                  default: 41e9d79cc47518930bc322d9bf7cddd260a0260a8d
                owner_address:
                  type: string
                  default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e
                amount:
                  type: integer
                  default: 1000
                visible:
                  type: boolean
                  default: false
      responses:
        '200':
          description: Unsigned transaction object
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                  txID:
                    type: string
                  raw_data:
                    type: object
                    properties:
                      contract:
                        type: array
                      ref_block_bytes:
                        type: string
                      ref_block_hash:
                        type: string
                      expiration:
                        type: integer
                      timestamp:
                        type: integer
                  raw_data_hex:
                    type: string
  /createwitness:
    post:
      tags:
      - General
      summary: Wallet/Createwitness
      operationId: createWitness
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                owner_address:
                  type: string
                  description: 'Address that will become a witness. Use base58 with `visible: true`, or hex with `visible:
                    false`.'
                url:
                  type: string
                  description: Witness website URL (must be a valid URL)
                visible:
                  type: boolean
                  description: When true, addresses are base58; when false, hex.
                  default: true
              required:
              - owner_address
              - url
              example:
                owner_address: THPvaUhoh2Qn2y9THCZML3H815hhFhn5YC
                url: https://mywitness.example.com
                visible: true
      responses:
        '200':
          description: Witness creation transaction
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                    description: Whether addresses are in visible format
                  txID:
                    type: string
                    description: Transaction ID for witness creation
                  raw_data:
                    type: object
                    properties:
                      contract:
                        type: array
                        description: Contract details for witness creation
                      ref_block_bytes:
                        type: string
                        description: Reference block bytes
                      ref_block_hash:
                        type: string
                        description: Reference block hash
                      expiration:
                        type: number
                        description: Transaction expiration timestamp
                      timestamp:
                        type: number
                        description: Transaction creation timestamp
                  raw_data_hex:
                    type: string
                    description: Raw transaction data in hex format
  /delegateresource:
    post:
      tags:
      - General
      summary: Wallet/Delegateresource
      operationId: delegateResource
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - owner_address
              - receiver_address
              - balance
              - resource
              properties:
                owner_address:
                  type: string
                  default: 41608f8da72479edc7dd921e4c30bb7e7cddbe722e
                receiver_address:
                  type: string
                  default: 41e9d79cc47518930bc322d9bf7cddd260a0260a8d
                balance:
                  type: integer
                  default: 1000000
                resource:
                  type: string
                  enum:
                  - BANDWIDTH
                  - ENERGY
                  default: BANDWIDTH
                lock:
                  type: boolean
                  default: false
                lock_period:
                  type: integer
                  default: 0
                visible:
                  type: boolean
                  default: false
      responses:
        '200':
          description: Resource delegation transaction
          content:
            application/json:
              schema:
                type: object
                properties:
                  visible:
                    type: boolean
                  txID:
                    type: string
                  raw_data:
                    type: object
                    properties:
                      contract:
                        type: array
                      r

# --- truncated at 32 KB (321 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/chainstack/refs/heads/main/openapi/chainstack-tron-node-api-openapi.yml