Api/DepositApi

Deposit API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->deposit();

// TestNet API Call
$sdk->testnet()->api()->deposit();

Methods

Method	Description
getDeposits()	List all deposits for product
getDepositsCount()	Count of found entities for get deposits request

`getDeposits()`

Example

#️⃣ Execute command in terminal

✨ php -f getDeposits.php

Request

GET /v3/ledger/deposits

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->deposit()->getDeposits(
    [ float $page_size, ]
    [ float $page, ]
    [ string $sort, ]
    [ string $status, ]
    [ string $currency, ]
    [ string $tx_id, ]
    [ string $to, ]
    [ string $account_id ]
): \Tatum\Model\Deposit[]

Parameters

Name	Type	Description	Notes
$page_size	float	Max number of items per page is 50.	[optional]
$page	float	Page number	[optional]
$sort	string	Direction of sorting. Can be asc or desc	[optional]
$status	string	Status of the deposit	[optional]
$currency	string	Filter by currency	[optional]
$tx_id	string	Filter by txId	[optional]
$to	string	Filter by to address	[optional]
$account_id	string	Filter by account id	[optional]

Return type

\Tatum\Model\Deposit[]

Description

List all deposits for product

1 credit per API call.

Lists all deposits for API key.

`getDepositsCount()`

Example

#️⃣ Execute command in terminal

✨ php -f getDepositsCount.php

Request

GET /v3/ledger/deposits/count

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->deposit()->getDepositsCount(
    [ float $page_size, ]
    [ float $page, ]
    [ string $sort, ]
    [ string $status, ]
    [ string $currency, ]
    [ string $tx_id, ]
    [ string $to, ]
    [ string $account_id ]
): \Tatum\Model\EntitiesCount

Parameters

Name	Type	Description	Notes
$page_size	float	Max number of items per page is 50.	[optional]
$page	float	Page number	[optional]
$sort	string	Direction of sorting. Can be asc or desc	[optional]
$status	string	Type of the deposit	[optional]
$currency	string	Filter by currency	[optional]
$tx_id	string	Filter by txId	[optional]
$to	string	Filter by to address	[optional]
$account_id	string	Filter by account id	[optional]

Return type

\Tatum\Model\EntitiesCount

Description

Count of found entities for get deposits request

1 credit per API call.

Counts total entities found by get deposits request.