Developer Platform API Methods

API Methods of Developer Platform

TypeScript / JavaScript

Client Methods

• Client.init(config): Initializes the client with an API key, chain, and optional provider.

• Client.getApiKey(): Returns the currently configured API key.

• Client.getProvider(): Returns the configured provider URL.

• Client.getChainId(): Returns the selected chain ID.

Wallet Methods

• Wallet.create(): Creates a new wallet and returns its address, private key, and mnemonic.

• Wallet.balance(address): Fetches the native token balance for a wallet address.

Token Methods

• Token.getNativeTokenBalance(address): Returns the native token balance for a given wallet or CronosId.

• Token.getERC20TokenBalance(address, contractAddress, blockHeight?): Returns the ERC20 token balance.

• Token.transfer({ to, amount, contractAddress? }): Transfers native or ERC20 tokens.

• Token.wrap({ amount }): Wraps tokens.

• Token.swap({ fromContractAddress, toContractAddress, amount }): Swaps tokens.

• Token.getERC721TokenBalance(address, contractAddress): Returns ERC721 token balance.

• Token.getTokenOwner(contractAddress, tokenId): Returns the owner of a specific ERC721 token.

• Token.getTokenURI(contractAddress, tokenId): Returns the token URI of an ERC721 token.

• Token.getERC721Metadata(contractAddress): Returns metadata for an ERC721 contract.

• Token.getERC20Metadata(contractAddress): Returns metadata for an ERC20 contract.

Transaction Methods

• Transaction.getTransactionsByAddress(address, explorerAPIKey, session?, limit?, startBlock?, endBlock?): Returns transaction list.

• Transaction.getTransactionByHash(txHash): Returns a transaction by hash.

• Transaction.getTransactionStatus(txHash): Returns transaction status.

• Transaction.getTransactionCount(address): Returns the nonce/transaction count for a wallet.

• Transaction.getGasPrice(): Returns the current gas price.

• Transaction.getFeeData(): Returns fee-related data.

• Transaction.estimateGas(payload): Estimates the gas for a transaction.

Contract Methods

• Contract.getContractABI(contractAddress, explorerAPIKey): Returns the ABI of a smart contract.

• Contract.getContractCode(contractAddress): Returns bytecode of a smart contract.

Block Methods

• Block.getCurrentBlock(): Returns the latest block.

• Block.getBlockByTag(tag, txDetail?): Fetches block by tag or number.

CronosId Methods

• CronosId.forwardResolve(cronosId): Resolves a CronosId to a wallet address.

• CronosId.reverseResolve(address): Resolves an address to its CronosId (if any).

Defi Methods

• Defi.getWhitelistedTokens(protocol): Returns whitelisted tokens for a protocol.

• Defi.getAllFarms(protocol): Returns all farms for a protocol.

• Defi.getFarmBySymbol(protocol, symbol): Returns farm details by symbol.

Exchange Methods

• Exchange.getAllTickers(): Returns all market tickers.

• Exchange.getTickerByInstrument(instrumentName): Returns market data for a given trading pair.

Python

Client Methods

• Client.init(api_key, chain_id, provider=None): Initialize the SDK with API key, chain, and optional provider.

Wallet Methods

• Wallet.create(): Creates a new wallet.

• Wallet.get_balance(address): Returns the native token balance for a given wallet address.

Token Methods

• Token.get_native_balance(address): Fetches native token balance.

• Token.get_erc20_balance(address, contract_address, block_height='latest'): Fetches ERC20 token balance.

• Token.transfer_token(to, amount): Transfers tokens.

• Token.wrap_token(from_contract_address, to_contract_address, to, amount): Wraps tokens.

• Token.swap_token(from_contract_address, to_contract_address, to, amount): Swaps tokens.

Transaction Methods

• Transaction.get_transactions_by_address(address, session='', limit='20'): Returns transaction list for address.

• Transaction.get_transaction_by_hash(tx_hash): Returns a transaction by hash.

• Transaction.get_transaction_status(tx_hash): Returns the status of a transaction.

• Transaction.get_transaction_count(address): Returns nonce for a wallet.

• Transaction.get_gas_price(): Returns current gas price.

• Transaction.get_fee_data(): Returns fee-related data.

• Transaction.estimate_gas(payload): Estimates gas for a given transaction payload.

Contract Methods

• Contract.get_contract_abi(contract_address, explorer_api_key): Fetches contract ABI.

• Contract.get_contract_code(contract_address): Fetches contract bytecode.

Block Methods

• Block.get_current_block(): Returns the latest block.

• Block.get_by_tag(tag, tx_detail=False): Returns a block by tag or number.

CronosId Methods

• CronosId.forward_resolve(cronos_id): Resolves CronosId to address.

• CronosId.reverse_resolve(address): Resolves address to CronosId.

Defi Methods

• Defi.get_whitelisted_tokens(protocol): Returns list of whitelisted tokens.

• Defi.get_all_farms(protocol): Returns all farms.

• Defi.get_farm_by_symbol(protocol, symbol): Returns specific farm by symbol.

Exchange Methods

• Exchange.get_all_tickers(): Returns all tickers.

• Exchange.get_ticker_by_instrument(instrument_name): Returns specific ticker info.