Web3 Cloud API (1.0.0)

Download OpenAPI specification:Download

Block

GetBlock

Get block.

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

round

required

integer <int64>

Round.

Responses

Request samples

Payload

Content type

application/json

{"round": 33272191
}

Response samples

200
500

Content type

application/json

{"block": {"block_hash": "string",
"round": 0,
"participation_updates": {"expired_participation_accounts": ["string"
]
},
"previous_block_hash": "string",
"rewards": {"fee_sink": "string",
"rewards_calculation_round": 0,
"rewards_level": 0,
"rewards_pool": "string",
"rewards_rate": 0,
"rewards_residue": 0
},
"seed": "string",
"state_proof_tracking": [{"next_round": 0,
"online_total_weight": 0,
"state_proof_type": 0,
"voters_commitment": "string"
}
],
"timestamp": 0,
"transactions_root": "string",
"transactions_root_sha256": "string",
"txn_counter": 0,
"upgrade_state": {"current_protocol": "string",
"next_protocol": "string",
"next_protocol_approvals": 0,
"next_protocol_switch_on": 0,
"next_protocol_vote_before": 0
},
"upgrade_vote": {"upgrade_approve": true,
"upgrade_delay": 0,
"upgrade_propose": "string"
},
"proposer": "string"
}
}

Payment Transaction

GetPaymentTransaction

Get payment transaction.

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

transaction_id

required

string

Transaction id.

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": "6SZHXAAV7QRU67CRCMGKXAGKXXJNZI5DAUH5E3NC6AYKOW75YD7A"
}

Response samples

200
500

Content type

application/json

{"payment_transaction": {"transaction_id": "string",
"block_hash": "string",
"auth_address": "string",
"close_rewards": 0,
"closing_amount": 0,
"confirmed_round": 0,
"create_application_index": 0,
"create_asset_index": 0,
"fee": 0,
"first_valid": 0,
"global_state_delta": [{"key": "string",
"value": {"action": 0,
"bytes": "string",
"uint": 0
}
}
],
"group": "string",
"intra_round_offset": 0,
"last_valid": 0,
"lease": "string",
"local_state_delta": [{"address": "string",
"delta": [{"key": "string",
"value": {"action": 0,
"bytes": "string",
"uint": 0
}
}
]
}
],
"logs": ["string"
],
"note": "string",
"receiver_rewards": 0,
"rekey_to": "string",
"round_time": 0,
"sender": "string",
"sender_rewards": 0,
"signature": {"logicsig": {"args": ["string"
],
"logic": "string",
"multisig_signature": {"subsignature": [{"public_key": "string",
"signature": "string"
}
],
"threshold": 0,
"version": 0
},
"signature": "string"
},
"multisig": {"subsignature": [{"public_key": "string",
"signature": "string"
}
],
"threshold": 0,
"version": 0
},
"sig": "string"
},
"transaction_type": "string",
"payment_transaction": {"amount": 0,
"close_amount": 0,
"close_remainder_to": "string",
"receiver": "string"
},
"inner_payment_transactions": [{"sender": "string",
"payment_transaction": {"amount": 0,
"close_amount": 0,
"close_remainder_to": "string",
"receiver": "string"
}
}
]
}
}

GetPendingPaymentTransaction

Get pending payment transaction.

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

transaction_id

required

string

Transaction id.

Responses

Request samples

Payload

Content type

application/json

{"transaction_id": "6SZHXAAV7QRU67CRCMGKXAGKXXJNZI5DAUH5E3NC6AYKOW75YD7A"
}

Response samples

200
500

Content type

application/json

{"pending_payment_transaction": {"transaction_id": "string",
"sender": "string",
"fee": 0,
"first_valid": 0,
"last_valid": 0,
"note": "string",
"group": "string",
"lease": "string",
"rekey_to": "string",
"transaction_type": "string",
"receiver": "string",
"amount": 0,
"close_remainder_to": "string",
"closing_amount": 0
}
}

ListPaymentTransactions

List payment transactions.

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

Either the transaction_ids or group must be present.

transaction_ids	Array of strings Transaction ids.
group	string Transaction group.

Responses

Request samples

Payload

Content type

application/json

{"transaction_ids": ["6SZHXAAV7QRU67CRCMGKXAGKXXJNZI5DAUH5E3NC6AYKOW75YD7A"
],
"group": ["lKFW2hSTfZJB/6uTu6Uj0aIPcs0gEEEiLw/IrY19st8="
]
}

Response samples

200
500

Content type

application/json

{"payment_transactions": [{"transaction_id": "string",
"block_hash": "string",
"auth_address": "string",
"close_rewards": 0,
"closing_amount": 0,
"confirmed_round": 0,
"create_application_index": 0,
"create_asset_index": 0,
"fee": 0,
"first_valid": 0,
"global_state_delta": [{"key": "string",
"value": {"action": 0,
"bytes": "string",
"uint": 0
}
}
],
"group": "string",
"intra_round_offset": 0,
"last_valid": 0,
"lease": "string",
"local_state_delta": [{"address": "string",
"delta": [{"key": "string",
"value": {"action": 0,
"bytes": "string",
"uint": 0
}
}
]
}
],
"logs": ["string"
],
"note": "string",
"receiver_rewards": 0,
"rekey_to": "string",
"round_time": 0,
"sender": "string",
"sender_rewards": 0,
"signature": {"logicsig": {"args": ["string"
],
"logic": "string",
"multisig_signature": {"subsignature": [{"public_key": "string",
"signature": "string"
}
],
"threshold": 0,
"version": 0
},
"signature": "string"
},
"multisig": {"subsignature": [{"public_key": "string",
"signature": "string"
}
],
"threshold": 0,
"version": 0
},
"sig": "string"
},
"transaction_type": "string",
"payment_transaction": {"amount": 0,
"close_amount": 0,
"close_remainder_to": "string",
"receiver": "string"
},
"inner_payment_transactions": [{"sender": "string",
"payment_transaction": {"amount": 0,
"close_amount": 0,
"close_remainder_to": "string",
"receiver": "string"
}
}
]
}
]
}

ListPendingPaymentTransactions

List pending payment transactions.

Authorizations:

(x-api-keyx-api-noncex-api-signature)

Request Body schema: application/json

transaction_ids

Array of strings

Transaction ids.

Responses

Request samples

Payload

Content type

application/json

{"transaction_ids": ["6SZHXAAV7QRU67CRCMGKXAGKXXJNZI5DAUH5E3NC6AYKOW75YD7A"
]
}

Response samples

200
500

Content type

application/json

{"pending_payment_transactions": [{"transaction_id": "string",
"sender": "string",
"fee": 0,
"first_valid": 0,
"last_valid": 0,
"note": "string",
"group": "string",
"lease": "string",
"rekey_to": "string",
"transaction_type": "string",
"receiver": "string",
"amount": 0,
"close_remainder_to": "string",
"closing_amount": 0
}
]
}