Get Testing Coins

Cobo

Developer Hub

Get Started

API References

Log In

Explore Cobo

Introduction

Wallet as a Service

Custodial Wallet Solution based on HSM/SGX

TSS Node Callback Mechanism

Callback Server Configuration

TSS Node Configuration & Callback Server Startup

Access Control Framework for Smart Contract Wallets

Github

Twitter

LinkedIn

Discord

Telegram

News

Quickstart

Authentication

Try out API endpoints directly in your browser.

API Playground

Error Codes

Transaction Notification

Withdrawal Confirmation

Cobo Callback Signature

If you’re working with Python, the official [cobo-python-api](https://github.com/CoboGlobal/cobo-python-api) package is the easiest way to use.

Python

If you’re working with JavaScript, the official [cobo-js-api](https://github.com/CoboGlobal/cobo-js-api) package is the easiest way to use.

JavaScript

If you’re working with Java, the official [cobo-java-api](https://github.com/CoboGlobal/cobo-java-api) package is the easiest way to use.

Java

If you’re working with Go, the official [cobo-go-api](https://github.com/CoboGlobal/cobo-go-api) package is the easiest way to use.

If you’re working with PHP, the official [cobo-php-api](https://github.com/CoboGlobal/cobo-php-api) package is the easiest way to use.

Cobo Safe Python Kit

MPC Recovery Kits

FAQ about WaaS

This endpoint returns a JSON response with detailed information about the organization associated with the authenticated user's custody wallet.

Get Account Details

This endpoint returns a JSON response with the currency rate and unit for a given coin code. The endpoint requires authentication and takes a 'coin_code' parameter in the GET request.

Get Coin Details

This endpoint returns a JSON response with a list of supported coins for the WaaS API.

Get Supported Coins

This endpoint generates a new cryptocurrency address for a given coin and returns it in a JSON response. The endpoint requires authentication and takes in two parameters: 'coin' and 'native_segwit'. The 'coin' parameter specifies the cryptocurrency for which the address needs to be generated, and the 'native_segwit' parameter is a boolean flag indicating whether the address should be generated using native segwit format. The endpoint checks for permission and address count limits before generating the new address.

Get New Deposit Address

This endpoint generates new addresses for a given coin and returns them in a JSON response. The number of addresses to generate can be specified in the request body. The endpoint checks if the user has permission to add new addresses and if the requested number of addresses is within the allowed limit. It also checks if the requested coin is supported and generates the addresses using the specified wallet. The response contains the coin and a list of generated addresses.

Get New Deposit Addresses

This endpoint returns information about a given address for a specific coin. It checks if the address belongs to the custody wallet and raises an exception if it doesn't. The response is a JSON object containing the coin and address fields.

Get Address Info

This endpoint returns information about a list of addresses for a specific coin. The endpoint accepts GET and POST requests with parameters 'coin' and 'address'. The 'coin' parameter specifies the coin type, and the 'address' parameter is a comma-separated list of addresses. The response contains the coin type and a comma-separated list of addresses that belong to the custody wallet of the authenticated user.

Get Addresses Info

This endpoint checks whether a given cryptocurrency address is valid and returns a boolean value. It also supports memo for certain coins. Authentication is required to access this endpoint.

Verify Valid Address

This endpoint returns a list of addresses associated with a custody wallet for a given coin, with pagination support. The response is a JSON array of objects, each containing a 'coin' field and an 'address' field.

Get Address History

This endpoint returns information about whether a given address is an internal address or not. If the address is internal, it also returns the name of the organization and wallet associated with the address. The endpoint takes three parameters: 'coin', 'address', and 'memo' (optional). If the address contains a '|' character, the address is split into two parts: the address itself and the memo. Otherwise, the memo parameter is used. The endpoint requires authentication.

Get Internal Address Info

This endpoint returns information about the given addresses for a specific coin. It takes a GET or POST request with parameters 'coin' and 'address', where 'coin' is the cryptocurrency symbol and 'address' is a comma-separated list of addresses. The response is a list of dictionaries, where each dictionary contains information about the corresponding address, including whether it is an internal address or wallet address.

Get Internal Addresses Info

Loop Transaction Explorer

This endpoint retrieves a transaction by its ID from the WaaS API. The endpoint requires authentication and takes a single query parameter, 'id', which is the ID of the transaction to retrieve. 

Get Transaction Details

This endpoint returns a list of transactions filtered by various parameters such as coin, address, side, and transaction ID range. The response includes transaction details such as transaction ID, coin type, amount, and timestamp.

Get Transactions By ID

This endpoint returns a JSON response containing transaction information for the given request IDs. The request IDs should be provided as a comma-separated string in the 'request_ids' parameter of the GET request. The maximum number of request IDs that can be provided is 50.

Get Transactions By Request IDs

This endpoint retrieves transaction details by transaction ID. It requires authentication and takes a single query parameter 'txid' which is the transaction ID to retrieve details for. The response is a JSON object containing transaction details.

Get Transaction By Txid

This endpoint returns a list of transactions filtered by time range, coin type, transaction side (deposit/withdraw), and address. The response includes transaction details such as transaction hash, amount, and timestamp.

Get Transaction By Time

This endpoint returns a JSON response with the details of a pending transaction specified by its ID.

This endpoint returns a JSON response with a list of pending transactions filtered by coin, side, max_id, min_id, and limit parameters. The response includes transaction details such as transaction ID, coin type, amount, and timestamp.

This endpoint returns a JSON response containing the transaction history for a given coin and address. The response can be filtered by various parameters such as side, max_id, min_id, begin_time, end_time, and include_financial. The maximum number of transactions returned is 50.

This endpoint allows users to create a new withdrawal request for a specified coin. The request requires authentication and the necessary parameters include the coin, request ID, withdrawal address, and amount. Optional parameters include a memo, force_external, and force_internal. The response will contain information about the newly created withdrawal request. 

This endpoint returns information about a withdrawal transaction given a request ID. The response is a JSON object containing details about the transaction such as the transaction hash, amount, and status.

This endpoint returns information about a staking product with the given product ID. The response is a JSON object containing details about the product, such as its name, description, and rewards. The language parameter can be used to specify the language of the response (default is English).

Get Staking Product Details

This endpoint returns a list of staking products available for a given coin and language. The response is a JSON array containing objects with information about each staking product, such as the name, annual yield, and minimum staking amount.

Get All Staking Product List

This endpoint allows users to stake a certain amount of cryptocurrency on a particular product. The user must provide the product ID and the amount they wish to stake. The endpoint will then attempt to stake the specified amount on the specified product. If the product ID is invalid, an error will be returned.

Stake

This endpoint allows users to stake or unstake a certain amount of a specified product in their custody wallet. The product_id and amount parameters are required in the POST request body. The endpoint first checks if the specified product exists, and then calls the pos_unstake method of the CustodyPosService to perform the staking or unstaking operation.

Unstake

This endpoint returns a list of staking information for a given coin and language. The response includes staking ID, coin, decimal, amount, reward coin, reward coin decimal, reward amount, and product information. The product information is parsed based on the language parameter.

Get Staking Data

This endpoint returns a JSON response with a list of unstaking and liquidating positions for the specified coin.

Get Unstaking Data

This endpoint returns a list of staking activities for a given coin, with optional filters for activity type, maximum ID, limit, and product ID. The response includes the activity ID, coin, amount, type, raw type, time, and product information.

Get All Staking History

This endpoint allows users to withdraw funds from their exchange account. The user must provide their exchange account token, the coin they wish to withdraw, the amount they wish to withdraw, and a unique request ID. The endpoint returns a JSON response with information about the withdrawal, including the request ID, the coin, the absolute amount withdrawn, the estimated amount received, the withdrawal status, the absolute fee, and the fee.

Withdraw to Investor's Wallet

This endpoint returns information about a trading withdraw request. It requires a valid request ID and returns details such as the coin code, amount, fee, and status of the request. The response also includes the estimated amount received after deducting the fee.

Get Trading Withdrawal Information

This endpoint allows users to deposit funds into their trading account. The user must provide their exchange account token, the coin they wish to deposit, the amount they wish to deposit, and a unique request ID. The endpoint returns a JSON response with information about the deposit, including the request ID, the coin, the absolute amount deposited, the estimated amount received, the status of the deposit, the absolute fee charged, and the fee in the same coin as the deposit.

Deposit to Exchange Account (Investor Only)

This endpoint returns information about a trading deposit. It requires a valid request ID and authentication with operation permission. The response contains details about the deposit, including the coin code, amount, estimated amount received, status, and fee.

Get Trading Deposit Information (Investor Only)

This endpoint allows authenticated traders to transfer funds between their exchange accounts. The request must include the 'from_exchange_account_token', 'to_exchange_account_token', 'coin', 'amount', and 'request_id' parameters. The response includes information about the transfer, such as the requested and estimated amounts, fees, and status.

Transfer Among Exchange Account

This endpoint returns information about a trading transfer request. It requires a 'request_id' parameter in the query string. The response contains details such as the coin, amount, fee, and status of the transfer request.

Get Trading Transfer Information

This endpoint returns a JSON response with a 'chain_codes' field containing a list of supported chain codes for the MPC custody wallet associated with the authenticated user.

Get Supported Chains

This endpoint returns a JSON response containing a list of supported coins for a given chain. The response includes the coin code, display code, description, decimal, deposit and withdrawal availability, and confirming threshold.

This endpoint returns a JSON response with a list of supported coins for a specific MPC wallet. The response includes the coin name, chain code, display code, description, decimal, and other relevant information such as whether the coin can be deposited or withdrawn, and the confirming threshold.

Get Wallet Supported Coins

This endpoint checks if a given address is valid for a specified coin. It also supports memos for certain coins. The response is a boolean indicating whether the address is valid or not.

Is Valid Address

This endpoint generates new addresses for a given chain code and returns a list of the generated addresses. The number of addresses to generate is specified in the 'count' parameter of the POST request. The maximum number of addresses that can be generated in one request is 200. The endpoint also checks if the organization has permission to add addresses and if the number of addresses being added exceeds the minutely limit. The response contains a list of the generated addresses along with their IDs, HD paths, and encodings.

Generate Addresses

This endpoint returns a JSON response containing a list of wallet addresses and their associated information. The endpoint takes in a chain code and optional parameters for pagination and sorting. The response includes the total count of addresses and a list of addresses with their respective ID, address, encoding, and HD path.

Get Addresses List

This endpoint returns the balance of a given address in a custody wallet. The response contains information about the coins and NFTs held by the address, including their balance, decimal, and description.

Get Balance

This endpoint returns a JSON response with a list of token assets and their balances for a given custody wallet. The response includes the total count of token assets, as well as information about each asset, such as the coin type, chain code, display code, and balance. Additionally, if any of the token assets are NFTs, the response will include information about the NFT, such as the NFT code, token ID, and contract address.

Get Balances List

This endpoint returns a JSON response containing a list of spendable unspent transaction outputs (UTXOs) for a given asset coin and address. The response includes the transaction hash, output index, address, amount, and confirmation status of each UTXO.

Get Spendable List

This endpoint estimates the fee for a given transaction. It takes in various parameters such as the coin type, amount, address, gas price, gas limit, and extra parameters. The response includes the fee amount in different levels such as slow, average, and fast.

Get Estimate Fee

This endpoint returns a JSON response with a list of supported NFT collections on the specified chain. The response includes the NFT code, chain code, contract address, description, display code, and standard for each supported collection.

Get Supported NFT Collections

This endpoint returns a list of transactions filtered by various parameters such as start and end time, transaction status, transaction type, coins, and addresses. The response is a JSON object containing a list of transactions.

Get Transactions List

This endpoint returns a JSON response containing transaction information for a list of transaction request IDs. The response includes the transaction ID, request ID, status, and other relevant information. The endpoint requires authentication and accepts optional query parameters to filter the results by transaction status.

Get Transactions By Request ID

This endpoint returns a list of transaction requests based on the provided cobo_ids and status. The cobo_ids parameter is a comma-separated list of cobo ids. The status parameter is an optional integer representing the status of the transaction request. The response is a JSON object containing an array of transaction request objects.

Get Transactions By Cobo ID

This endpoint returns transaction details for a given transaction hash. The response is a JSON object containing transaction details such as transaction hash, block number, sender address, recipient address, value, and gas used. The endpoint also accepts an optional parameter 'transaction_type' to filter the transaction details based on the type of transaction.

Get Transactions By Tx Hash

This endpoint creates a transaction for a given coin and request ID. The request must include the amount, from_address, and to_address. Optional parameters include fee, gas_price, gas_limit, max_fee, max_priority_fee, operation, and extra_parameters. The endpoint returns a JSON response with a 'cobo_id' field containing the ID of the created transaction.

Create Transaction

This endpoint allows users to speed up a previously submitted transaction by replacing it with a new transaction with higher gas price. The endpoint accepts a POST request with parameters including cobo_id, request_id, fee, gas_price, gas_limit, and fee_amount. The response is a JSON object containing the updated transaction information.

Speedup Transaction

This endpoint is accessible via a POST request to https://api.custody.cobo.com/CustodyMPCApi/drop_transaction/. It accepts parameters 'cobo_id' and 'request_id' as required fields, and 'fee', 'gas_price', 'gas_limit', and 'fee_amount' as optional fields. The endpoint returns a JSON response containing information about the transaction request.

Drop Transaction

This endpoint retries a double check for a withdrawal request with the given request_id. The request must be a POST request and the user must have all permissions. The endpoint retrieves the withdrawal request with the given request_id and checks if it exists and has a status of 'STATUS_WAITING_DOUBLE_CHECK'. If the request is valid, the endpoint locks the record and processes the withdrawal request with the 'process_waiting_double_check_withdraw_request' method from the CustodyService class.

Retry Double Check

Sign Message

This endpoint returns a JSON response containing signed messages information for a list of Cobo IDs. The response includes the request ID, Cobo ID, signature and other relevant information.

Get Signed Messages By Cobo ID

This endpoint returns a JSON response containing signed messages information for a list of request IDs. The response includes the request ID, Cobo ID, signature and other relevant information.

Get Signed Messages By Request ID

This endpoint returns a JSON response containing a list of TSS (Threshold Signature Scheme) requests with their metadata. The requests can be filtered by request type and status. The metadata includes the COBO ID, request type, status, failed reason (if any), and additional information specific to the request type (e.g., threshold and node IDs for key generation requests).

Get Tss Node Requests List

This endpoint returns a JSON response containing a list of TSS nodes that configured on the Custody MPC Setting page. The response includes node id, node type and if the node is online.

Get Tss Node List

This endpoint creates a binding between a user in the prime broker system and a user in the custody system. It requires a POST request with a 'user_id' field in the request body, and the user must have all necessary permissions. The response is a JSON object with a 'binder_id' field containing the ID of the newly created binding.

Create Binding

This endpoint returns a JSON response with the binding information for a given binder ID. The endpoint requires authentication and the user must have query permission. The binder ID is passed as a parameter in the GET request.

Query Binding

This endpoint is a GET request that requires a 'user_id' parameter. It returns a JSON response containing the user's authentication information queried from PrimeBrokerManager. Authentication is required to access this endpoint.

Query User Auth

This endpoint allows a prime broker to bind a list of chain addresses to a user account. The endpoint requires a POST request with a JSON payload containing the user ID and a list of chain addresses. If the payload is valid, the endpoint returns a JSON response with the result of the binding operation.

Bind Addresses

This endpoint allows authenticated users to change their binding to a new Prime Broker. The user's `broker_user_id` is passed in the request body, and the new `binder_id` is returned in the JSON response.

Change Binding

This endpoint allows users to unbind their broker account from their MPC Wallet account. It requires a POST request with a 'user_id' field in the request body. The response is a JSON object containing a 'statement_id' field which can be used to query the status of the unbinding process.

Unbind Binding

This endpoint allows authenticated users to query a statement by providing a statement ID. The response is a JSON object containing information about the statement, including its ID, creation time, and a list of transactions. The endpoint requires the user to have query permission.

Overview

Development

SDKs

Tools

FAQ

Get Testing Coins