Oasys

#

• Address
  • postBatchRegisterAddresses
  • postBatchRemoveAddresses
  • postRegisterAddress
  • postRemoveAddress
• Transaction
  • postCancelTransaction
  • postCreateTokenTransaction
  • postCreateTransaction
  • postGetEstimatedFee
  • postGetTransaction
  • postGetTransactionMessageToSign
  • postListTransactions
  • postSendTransaction
  • postSubmitTransactionSignature
• Contract
  • postGetContract
  • postListContracts
  • postRegisterContract
  • postRemoveContract
• Wallet
  • postGetWallet
  • postListWallets
  • postRegisterWallet
  • postUpdateConfirmation
• Asset
  • postListAssets
  • postRefreshAssetBalances
• Transfer
  • postListTransfers
• Webhook
  • postListWebhookHeaders
  • postListWebhookHistories
  • postListWebhooks
  • postRegisterWebhook
  • postRegisterWebhookHeader
  • postRemoveWebhook
  • postRemoveWebhookHeader

API docs by Redocly

Web3 Cloud API (1.0.0)

Download OpenAPI specification:Download

Address

BatchRegisterAddresses

Batch register addresses to given wallet.

Authorizations:

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

Request Body schema: application/json

wallet_id required	string Unique ID of wallet.
addresses	Array of strings [ 1 .. 1000 ] items EVM addresses.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/BatchRegisterAddresses

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "addresses": [

  • "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

  ]

}

Response samples

• 200
• 500

Content type

application/json

{ }

BatchRemoveAddresses

Batch remove addresses from given wallet.

Authorizations:

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

Request Body schema: application/json

wallet_id required	string Unique ID of wallet.
addresses	Array of strings [ 1 .. 1000 ] items EVM addresses.
remove_all	boolean If true, remove all addresses for given wallet.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/BatchRemoveAddresses

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "addresses": [

  • "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

  ],
• "remove_all": true

}

Response samples

• 200
• 500

Content type

application/json

{ }

RegisterAddress

Register address to given wallet.

Authorizations:

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

Request Body schema: application/json

wallet_id required	string Unique ID of wallet.
address required	string^0x[a-f0-9]{40}$ EVM address.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RegisterAddress

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

}

Response samples

• 200
• 500

Content type

application/json

{ }

RemoveAddress

Remove address from given wallet.

Authorizations:

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

Request Body schema: application/json

wallet_id required	string Unique ID of wallet.
address required	string^0x[a-f0-9]{40}$ EVM address.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RemoveAddress

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

}

Response samples

• 200
• 500

Content type

application/json

{ }

Transaction

CancelTransaction

Cancel transaction.

Authorizations:

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

Request Body schema: application/json

transaction_id required

string Unique ID of transaction.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/CancelTransaction

Request samples

• Payload

Content type

application/json

{

• "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{ }

CreateTokenTransaction

Create transaction to transfer tokens.

Authorizations:

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

Request Body schema: application/json

wallet_id required	string Unique ID of wallet.
contract_type required	any Enum: "CONTRACT_TYPE_ERC20" "CONTRACT_TYPE_ERC721" Type of contract.
from required	string^0x[a-f0-9]{40}$ Sender EVM address.
to required	string^0x[a-f0-9]{40}$ Recipient EVM address.
gas	string Decimal value of gas for transaction in wei. Default gas is set by eth_estimateGas.
max_fee_per_gas	string Decimal value of maxFeePerGas for transaction in wei. Default max fee per gas is (2 * latestBlock.baseFeePerGas) + maxPriorityFeePerGas.
max_priority_fee_per_gas	string Default: "0" Decimal value of maxPriorityFeePerGas for transaction in wei.
	object (v1TokenPayload)
nonce	integer <int64> Transaction nonce. Default nonce is set by eth_getTransactionCount.
transaction_id	string Unique ID of transaction to be created. If not provided, newly generated uuid is assigned.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/CreateTokenTransaction

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "contract_type": "CONTRACT_TYPE_ERC20",
• "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
• "gas": "1000000000",
• "max_fee_per_gas": "1000000000",
• "max_priority_fee_per_gas": "1000000000",
• "token_payload": {

  • "erc20": {

    • "contract_address": "0xeedba2484aaf940f37cd3cd21a5d7c4a7dafbfc0",
    • "value": "10000"

    },
  • "erc721": {

    • "contract_address": "0xeedba2484aaf940f37cd3cd21a5d7c4a7dafbfc0",
    • "token_id": "68391930"

    },
  • "erc1155": {

    • "contract_address": "0xeedba2484aaf940f37cd3cd21a5d7c4a7dafbfc0",
    • "token_id": "68391930",
    • "value": "10000"

    }

  },
• "nonce": "10",
• "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{

• "transaction": {

  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "transaction_id": "1027162e-b578-48ce-a2fa-59637992c6e2",
  • "transaction_hash": "0x3be3bbd3d28a3af1789d7705947bf3988388f4ba201a8d580d16e4558e5b2ccc",
  • "transaction_state": "TRANSACTION_STATE_CREATED",
  • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
  • "value": "1000000000",
  • "gas": "1000000000",
  • "max_fee_per_gas": "1000000000",
  • "max_priority_fee_per_gas": "1000000000",
  • "data": "0xa9059cbb000000000000000000000000ce133b2cc42f16b4aadcbec492ddc2dfe1dc29900000000000000000000000000000000000000000000000006fae442a611eaad0",
  • "nonce": "10"

  }

}

CreateTransaction

Create transaction.

Authorizations:

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

Request Body schema: application/json

wallet_id required	string Unique ID of wallet.
from required	string^0x[a-f0-9]{40}$ Sender EVM address.
to required	string^0x[a-f0-9]{40}$ Recipient EVM address.
value required	string Decimal value to send for transaction in wei.
gas	string Decimal value of gas for transaction in wei. Default gas is set by eth_estimateGas.
max_fee_per_gas	string Decimal value of maxFeePerGas for transaction in wei. Default max fee per gas is (2 * latestBlock.baseFeePerGas) + maxPriorityFeePerGas.
max_priority_fee_per_gas	string Default: "0" Decimal value of maxPriorityFeePerGas for transaction in wei.
data	string Transaction data.
nonce	integer <int64> Transaction nonce. Default nonce is set by eth_getTransactionCount.
transaction_id	string Unique ID of transaction to be created. If not provided, newly generated uuid is assigned.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/CreateTransaction

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
• "value": "1000000000",
• "gas": "1000000000",
• "max_fee_per_gas": "1000000000",
• "max_priority_fee_per_gas": "1000000000",
• "data": "0xa9059cbb000000000000000000000000ce133b2cc42f16b4aadcbec492ddc2dfe1dc29900000000000000000000000000000000000000000000000006fae442a611eaad0",
• "nonce": "10",
• "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{

• "transaction": {

  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "transaction_id": "1027162e-b578-48ce-a2fa-59637992c6e2",
  • "transaction_hash": "0x3be3bbd3d28a3af1789d7705947bf3988388f4ba201a8d580d16e4558e5b2ccc",
  • "transaction_state": "TRANSACTION_STATE_CREATED",
  • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
  • "value": "1000000000",
  • "gas": "1000000000",
  • "max_fee_per_gas": "1000000000",
  • "max_priority_fee_per_gas": "1000000000",
  • "data": "0xa9059cbb000000000000000000000000ce133b2cc42f16b4aadcbec492ddc2dfe1dc29900000000000000000000000000000000000000000000000006fae442a611eaad0",
  • "nonce": "10"

  }

}

GetEstimatedFee

Authorizations:

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

Request Body schema: application/json

object (v1GetEstimatedFeeRequest)

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/GetEstimatedFee

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 500

Content type

application/json

{

• "base_fee_per_gas": "string",
• "priority_fee_per_gas": {

  • "slow": "83973642",
  • "average": "937434151",
  • "fast": "67213164846"

  }

}

GetTransaction

Get transaction.

Authorizations:

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

Request Body schema: application/json

Either the transaction_id or transaction_hash must be present.

transaction_id	string Unique ID of transaction.
transaction_hash	string Transaction hash.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/GetTransaction

Request samples

• Payload

Content type

application/json

{

• "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "transaction_hash": "0x1832e1bd87663e585cba09672468e07bba651f29d93c04df3e93e276448be0d6"

}

Response samples

• 200
• 500

Content type

application/json

{

• "transaction": {

  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "transaction_id": "1027162e-b578-48ce-a2fa-59637992c6e2",
  • "transaction_hash": "0x3be3bbd3d28a3af1789d7705947bf3988388f4ba201a8d580d16e4558e5b2ccc",
  • "transaction_state": "TRANSACTION_STATE_CREATED",
  • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
  • "value": "1000000000",
  • "gas": "1000000000",
  • "max_fee_per_gas": "1000000000",
  • "max_priority_fee_per_gas": "1000000000",
  • "data": "0xa9059cbb000000000000000000000000ce133b2cc42f16b4aadcbec492ddc2dfe1dc29900000000000000000000000000000000000000000000000006fae442a611eaad0",
  • "nonce": "10"

  }

}

GetTransactionMessageToSign

Get hashed transaction message to sign.

Authorizations:

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

Request Body schema: application/json

transaction_id required

string Unique ID of transaction.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/GetTransactionMessageToSign

Request samples

• Payload

Content type

application/json

{

• "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{

• "transaction_message_to_sign": "string"

}

ListTransactions

List transactions.

Authorizations:

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

Request Body schema: application/json

Either the wallet_id or address must be present.

wallet_id	string Unique ID of wallet.
address	string^0x[a-f0-9]{40}$ EVM address.
page_size	integer <int64> <= 100 Default: "10" Number of items per page.
page_token	string Token for next page.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListTransactions

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "page_size": "10",
• "page_token": "CXART7WOIQT6AAAK"

}

Response samples

• 200
• 500

Content type

application/json

{

• "transactions": [

  • {

    • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
    • "transaction_id": "1027162e-b578-48ce-a2fa-59637992c6e2",
    • "transaction_hash": "0x3be3bbd3d28a3af1789d7705947bf3988388f4ba201a8d580d16e4558e5b2ccc",
    • "transaction_state": "TRANSACTION_STATE_CREATED",
    • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
    • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
    • "value": "1000000000",
    • "gas": "1000000000",
    • "max_fee_per_gas": "1000000000",
    • "max_priority_fee_per_gas": "1000000000",
    • "data": "0xa9059cbb000000000000000000000000ce133b2cc42f16b4aadcbec492ddc2dfe1dc29900000000000000000000000000000000000000000000000006fae442a611eaad0",
    • "nonce": "10"

    }

  ],
• "pagination": {

  • "next_page_token": "CXART7WOIQT6AAAK"

  }

}

SendTransaction

Send transaction.

Authorizations:

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

Request Body schema: application/json

transaction_id required

string Unique ID of transaction.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/SendTransaction

Request samples

• Payload

Content type

application/json

{

• "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{

• "transaction": {

  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "transaction_id": "1027162e-b578-48ce-a2fa-59637992c6e2",
  • "transaction_hash": "0x3be3bbd3d28a3af1789d7705947bf3988388f4ba201a8d580d16e4558e5b2ccc",
  • "transaction_state": "TRANSACTION_STATE_CREATED",
  • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
  • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
  • "value": "1000000000",
  • "gas": "1000000000",
  • "max_fee_per_gas": "1000000000",
  • "max_priority_fee_per_gas": "1000000000",
  • "data": "0xa9059cbb000000000000000000000000ce133b2cc42f16b4aadcbec492ddc2dfe1dc29900000000000000000000000000000000000000000000000006fae442a611eaad0",
  • "nonce": "10"

  }

}

SubmitTransactionSignature

Submit transaction signature.

Authorizations:

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

Request Body schema: application/json

transaction_id required	string Unique ID of transaction.
signature required	string Transaction signature.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/SubmitTransactionSignature

Request samples

• Payload

Content type

application/json

{

• "transaction_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "signature": "0x93a46510a732f004451ac426efa4bac805d1edac6c8c4bf6d77aea48a8d5bc11149750fdbe00a0f189bfd694b33b9e15d052f174ff8664189b616a3dfce2225901"

}

Response samples

• 200
• 500

Content type

application/json

{ }

Contract

GetContract

Get registered contract.

Authorizations:

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

Request Body schema: application/json

contract_address required

string^0x[a-f0-9]{40}$ EVM contract address.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/GetContract

Request samples

• Payload

Content type

application/json

{

• "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

}

Response samples

• 200
• 500

Content type

application/json

{

• "contract": {

  • "contract_address": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
  • "contract_type": "CONTRACT_TYPE_ERC20",
  • "contract_metadata": null

  }

}

ListContracts

List registered contracts.

Authorizations:

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

Request Body schema: application/json

object (v1ListContractsRequest)

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListContracts

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 500

Content type

application/json

{

• "contracts": [

  • {

    • "contract_address": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
    • "contract_type": "CONTRACT_TYPE_ERC20",
    • "contract_metadata": null

    }

  ]

}

RegisterContract

Register contract to record contract activity.

Authorizations:

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

Request Body schema: application/json

contract_address required	string^0x[a-f0-9]{40}$ EVM contract address.
contract_type required	any Enum: "CONTRACT_TYPE_ERC20" "CONTRACT_TYPE_ERC721" "CONTRACT_TYPE_ERC1155" Type of contract.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RegisterContract

Request samples

• Payload

Content type

application/json

{

• "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "contract_type": "CONTRACT_TYPE_ERC20"

}

Response samples

• 200
• 500

Content type

application/json

{ }

RemoveContract

Remove contract.

Authorizations:

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

Request Body schema: application/json

contract_address required

string^0x[a-f0-9]{40}$ EVM contract address.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RemoveContract

Request samples

• Payload

Content type

application/json

{

• "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

}

Response samples

• 200
• 500

Content type

application/json

{ }

Wallet

GetWallet

Get wallet. 404 error will be returned if the wallet is not found.

Authorizations:

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

Request Body schema: application/json

Either the wallet_id or address must be present.

wallet_id	string Unique ID of wallet.
address	string^0x[a-f0-9]{40}$ EVM address.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/GetWallet

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

}

Response samples

• 200
• 500

Content type

application/json

{

• "wallet": {

  • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
  • "name": "Alice Wallet",
  • "addresses": [

    • "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

    ],
  • "confirmation": 1,
  • "create_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z"

  }

}

ListWallets

List wallets.

Authorizations:

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

Request Body schema: application/json

page_size	integer <int64> <= 100 Default: "10" Number of items per page.
page_token	string Token for next page.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListWallets

Request samples

• Payload

Content type

application/json

{

• "page_size": 10,
• "page_token": "CXART7WOIQT6AAAK"

}

Response samples

• 200
• 500

Content type

application/json

{

• "wallets": [

  • {

    • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
    • "name": "Alice Wallet",
    • "addresses": [

      • "0xb88a7eee158b6f52094cce356f1c138cc3cc678e"

      ],
    • "confirmation": 1,
    • "create_time": "2019-08-24T14:15:22Z",
    • "update_time": "2019-08-24T14:15:22Z"

    }

  ],
• "pagination": {

  • "next_page_token": "CXART7WOIQT6AAAK"

  }

}

RegisterWallet

Register wallet.

Authorizations:

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

Request Body schema: application/json

name required	string [ 1 .. 50 ] characters Wallet name.
address	string^0x[a-f0-9]{40}$ EVM address.
confirmation	integer <int64> Default: "10" Threshold of block confirmation number for wallet balance to be updated.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RegisterWallet

Request samples

• Payload

Content type

application/json

{

• "name": "Alice Wallet",
• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "confirmation": 1

}

Response samples

• 200
• 500

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

UpdateConfirmation

Update the threshold of block confirmation number for wallet balance to be updated.

Authorizations:

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

Request Body schema: application/json

wallet_id required	string Unique ID of wallet.
confirmation required	integer <int64> Default: "10" Block confirmation number.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/UpdateConfirmation

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "confirmation": 1

}

Response samples

• 200
• 500

Content type

application/json

{ }

Asset

ListAssets

List assets of given wallet or address.

Authorizations:

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

Request Body schema: application/json

Either the wallet_id or address must be present.

wallet_id	string Unique ID of wallet.
asset_type required	any Enum: "ASSET_TYPE_OAS" "ASSET_TYPE_ERC20" "ASSET_TYPE_ERC721" "ASSET_TYPE_ERC1155" Type of asset.
address	string^0x[a-f0-9]{40}$ EVM address.
is_aggregated	boolean If true, aggregate the balances of all addresses for each asset type.
contract_address	string^0x[a-f0-9]{40}$ EVM contract address.
page_size	integer <int64> <= 100 Default: "10" Number of items per page.
page_token	string Token for next page.
exclude_zero_balance	boolean Default: "false" If true, exclude asset whose balance is 0.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListAssets

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "asset_type": "ASSET_TYPE_ERC20",
• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "is_aggregated": true,
• "contract_address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "page_size": 10,
• "page_token": "CXART7WOIQT6AAAK",
• "exclude_zero_balance": "false"

}

Response samples

• 200
• 500

Content type

application/json

{

• "assets": [

  • {

    • "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
    • "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
    • "asset_type": "ASSET_TYPE_ERC20",
    • "balance": "1.9582",
    • "asset_metadata": {

      • "erc20": {

        • "contract_address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        • "name": "Tether USD",
        • "symbol": "USDT",
        • "decimals": 6

        },
      • "erc721": {

        • "contract_address": "0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d",
        • "name": "BoredApeYachtClub",
        • "symbol": "BAYC",
        • "token_id": "3849",
        • "token_uri": "ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/3849",
        • "token_data": "{\"name\": \"Lorem ipsum dolor sit amet\"}"

        },
      • "erc1155": {

        • "contract_address": "0x495f947276749ce646f68ac8c248420045cb7b5e",
        • "token_id": "3849",
        • "token_uri": "ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/3849",
        • "token_data": "{\"name\": \"Lorem ipsum dolor sit amet\"}"

        }

      }

    }

  ],
• "pagination": {

  • "next_page_token": "CXART7WOIQT6AAAK"

  }

}

RefreshAssetBalances

Refresh balances of assets of given wallet or address.

Authorizations:

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

Request Body schema: application/json

Either the wallet_id or address must be present.

wallet_id	string Unique ID of wallet.
address	string^0x[a-f0-9]{40}$ EVM address.
asset_type required	any Enum: "ASSET_TYPE_OAS" "ASSET_TYPE_ERC20" "ASSET_TYPE_ERC721" "ASSET_TYPE_ERC1155" Type of asset.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RefreshAssetBalances

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "asset_type": "ASSET_TYPE_ERC20"

}

Response samples

• 200
• 500

Content type

application/json

{ }

Transfer

ListTransfers

Authorizations:

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

Request Body schema: application/json

Either the wallet_id, address or transaction_hash must be present.

address	string^0x[a-f0-9]{40}$ EVM address.
start_time	integer <int64> UnixTime indicating from which point to retrieve the transfer history.
end_time	integer <int64> UnixTime indicating until which point to retrieve the transfer history.
page_size	integer <int64> <= 100 Default: "10" Number of items per page.
page_token	string Token for next page.
wallet_id	string Unique ID of wallet.
transaction_hash	string Transaction hash.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListTransfers

Request samples

• Payload

Content type

application/json

{

• "address": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
• "start_time": 1690373019,
• "end_time": 1690374019,
• "page_size": 10,
• "page_token": "CXART7WOIQT6AAAK",
• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "transaction_hash": "0x1832e1bd87663e585cba09672468e07bba651f29d93c04df3e93e276448be0d6"

}

Response samples

• 200
• 500

Content type

application/json

{

• "transfers": [

  • {

    • "transaction_hash": "0x1832e1bd87663e585cba09672468e07bba651f29d93c04df3e93e276448be0d6",
    • "asset_type": "ASSET_TYPE_ERC20",
    • "nonce": "10",
    • "from": "0xb88a7eee158b6f52094cce356f1c138cc3cc678e",
    • "to": "0x95222290dd7278aa3ddd389cc1e1d165cc4bafe5",
    • "value": "1000000000",
    • "transaction_fee": "1000000000",
    • "transfer_state": "TRANSFER_STATE_SUCCESS",
    • "block_number": 17783352,
    • "block_timestamp": 1690452166,
    • "transfer_metadata": {

      • "erc20": {

        • "contract_address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        • "name": "Tether USD",
        • "symbol": "USDT",
        • "decimals": 6

        },
      • "erc721": {

        • "contract_address": "0xdac17f958d2ee523a2206206994597c13d831ec7",
        • "name": "BoredApeYachtClub",
        • "token_id": "3849",
        • "symbol": "BAYC",
        • "token_uri": "ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/3849",
        • "token_data": "{\"name\": \"Lorem ipsum dolor sit amet\"}"

        },
      • "erc1155": {

        • "contract_address": "0x495f947276749ce646f68ac8c248420045cb7b5e",
        • "token_id": "3849",
        • "token_uri": "ipfs://QmeSjSinHpPnmXmspMjwiXyN6zS4E9zccariGR3jxcaWtq/3849",
        • "token_data": "{\"name\": \"Lorem ipsum dolor sit amet\"}"

        }

      }

    }

  ],
• "pagination": {

  • "next_page_token": "CXART7WOIQT6AAAK"

  }

}

Webhook

ListWebhookHeaders

List webhook headers.

Authorizations:

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

Request Body schema: application/json

If webhook_id is not provided, return webhook headers without webhook_id.

webhook_id

string Unique ID of webhook.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListWebhookHeaders

Request samples

• Payload

Content type

application/json

{

• "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{

• "webhook_headers": [

  • {

    • "webhook_header_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
    • "webhook_id": "0211db8c-2a84-423c-b49b-31ae486d1675",
    • "header_key": "x-custom-header-key",
    • "header_value": "custom-header-value"

    }

  ]

}

ListWebhookHistories

List webhook histories.

Authorizations:

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

Request Body schema: application/json

webhook_id	string Unique ID of webhook.
start_time	integer <int64> UnixTime indicating from which point to retrieve the webhook history.
end_time	integer <int64> UnixTime indicating until which point to retrieve the webhook history.
page_size	integer <int64> <= 100 Default: "10" Number of items per page.
page_token	string Token for next page.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListWebhookHistories

Request samples

• Payload

Content type

application/json

{

• "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "start_time": 1690373019,
• "end_time": 1690374019,
• "page_size": 10,
• "page_token": "string"

}

Response samples

• 200
• 500

Content type

application/json

{

• "webhook_histories": [

  • {

    • "webhook_history_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
    • "webhook_id": "69fb80d8-998d-483b-b4db-068e7dac2374",
    • "webhook_endpoint": "https://test/webhook",
    • "webhook_status": "WEBHOOK_STATUS_COMPLETED",
    • "notification_type": "NOTIFICATION_TYPE_EVM_TRANSACTION_UPDATED",
    • "delivery_count": 1,
    • "delivery_time": "2019-08-24T14:15:22Z",
    • "data": { }

    }

  ],
• "pagination": {

  • "next_page_token": "CXART7WOIQT6AAAK"

  }

}

ListWebhooks

List webhooks.

Authorizations:

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

Request Body schema: application/json

object (v1ListWebhooksRequest)

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/ListWebhooks

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 500

Content type

application/json

{

• "webhooks": [

  • null

  ]

}

RegisterWebhook

Register webhook to get notified on wallet activities.

Authorizations:

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

Request Body schema: application/json

If wallet_id is not provided, webhook will be registered for all wallets.

wallet_id	string Unique ID of wallet.
webhook_endpoint required	string Webhook endpoint.
confirmation required	integer <int64> The threshold of block confirmations before the Webhook is triggered.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RegisterWebhook

Request samples

• Payload

Content type

application/json

{

• "wallet_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "webhook_endpoint": "https://test/webhook",
• "confirmation": 10

}

Response samples

• 200
• 500

Content type

application/json

{

• "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

RegisterWebhookHeader

Register webhook header.

Authorizations:

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

Request Body schema: application/json

If webhook_id is not provided, given webhook header will be applied to all webhooks.

webhook_id	string Unique ID of webhook.
header_key required	string <= 1000 characters Webhook header key.
header_value required	string <= 1000 characters Webhook header value.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RegisterWebhookHeader

Request samples

• Payload

Content type

application/json

{

• "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7",
• "header_key": "x-custom-header-key",
• "header_value": "custom-header-value"

}

Response samples

• 200
• 500

Content type

application/json

{

• "webhook_header_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

RemoveWebhook

Remove webhook.

Authorizations:

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

Request Body schema: application/json

webhook_id required

string Unique ID of webhook.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RemoveWebhook

Request samples

• Payload

Content type

application/json

{

• "webhook_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{ }

RemoveWebhookHeader

Remove webhook header.

Authorizations:

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

Request Body schema: application/json

webhook_header_id required

string Unique ID of webhook header.

Responses

https://web3-cloud-testnet-prd.gincoapis.com/gincoinc.web3cloud.oasys.gateway.v1.GatewayService/RemoveWebhookHeader

Request samples

• Payload

Content type

application/json

{

• "webhook_header_id": "3f80f049-b3be-4afd-ac46-1901d43232d7"

}

Response samples

• 200
• 500

Content type

application/json

{ }