Get fee
Return fees.
path Parameters
chainName of the chain
query Parameters
amountThe amount to transfer (string)
senderThe sender's information (string)
expirationThe expiration time (number)
token_typeThe type of token (string)
transfer_idThe transfer ID (string)
token_addressThe token address (string)
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get fee › Responses
Successful response
successamountfee_tokenfee_amounttotal_amountfee_authorizationmin_transfer_amountmax_transfer_amountmin_transfer_amount_usdmax_transfer_amount_usdpending_txsNumber of Linkdrop transactions stuck in the mempool
pending_blocksNumber of blocks the oldest pending transaction has been stuck in the mempool
pending_tx_submitted_atUNIX timestamp when the oldest pending transaction was submitted for inclusion in the blockchain
pending_tx_submitted_bnBlock number when the transaction was submitted for inclusion in the blockchain
Get limits
Get transfer limits for a token
path Parameters
chainName of the chain
query Parameters
token_addressAddress of the token
token_typeType of the token
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get limits › Responses
Successful response
successmax_transfer_amountmin_transfer_amountmin_transfer_amount_usdmax_transfer_amount_usdDeposit
Endpoint for depositing tokens.
path Parameters
chainName of the chain
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Deposit › Request Body
senderAddress of sender
tokenAddress of token contract
token_typeERC20 or NATIVE
escrowEscrow contract address
transfer_idTransfer ID
expirationExpiration timestamp
amountDeposit amount
tx_hashTransaction hash
total_amountDeposit amount including fees
fee_amountDeposit fee amount
fee_authorizationDeposit fee authorization
fee_tokenFee token
transaction_typeType of transaction. 'tx' by default
encrypted_sender_messageEncrypted message, added by the sender
Deposit › Responses
Successful response
successIndicates if the operation was successful
Deposit with authorization
Deposit tokens with authorization
path Parameters
chainName of the chain
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Deposit with authorization › Request Body
senderAddress of the sender
tokenAddress of the token contract
token_typeType of token - ERC20 or NATIVE
escrowAddress of the escrow contract
transfer_idTransfer ID
expirationTimestamp indicating expiration of deposit
amountTransfer amount
authorizationDeposit authorization
authorization_selectorAuthorization selector
total_amountDeposit amount including fees
fee_amountDeposit fee amount
fee_authorizationDeposit fee authorization
encrypted_sender_messageEncrypted message, added by the sender
Deposit with authorization › Responses
Successful transfer initiation
successIndicates if the transfer was successful
tx_hashTransaction hash of the initiated transfer
Redeem
Redeem tokens
path Parameters
chainName of the chain
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Redeem › Request Body
receiverAddress of receiver
senderAddress of sender
escrowEscrow contract address
transfer_idTransfer ID
receiver_sigReceiver's signature
tokenAddress of token contract
Redeem › Responses
Redeem successful
successIndicates if the transfer was successful
tx_hashHash of the transaction
Redeem recovered
Redeems tokens from recovered link.
path Parameters
chainName of the chain
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Redeem recovered › Request Body
receiverAddress of the receiver
senderAddress of the sender
escrowEscrow contract address
transfer_idTransfer ID
receiver_sigReceiver's signature
sender_sigSender's signature
tokenAddress of token contract
Redeem recovered › Responses
Transaction submitted successfully
successIndicates if the transaction was successful
tx_hashTransaction hash
Get payment status by transfer id
Get payment status by transfer id.
path Parameters
chainName of the chain
transfer_idID of the transfer
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get payment status by transfer id › Responses
Successful response
successGet payment status by tx hash
Retrieves information about a claim using the provided transaction hash
path Parameters
chainName of the chain
tx_hashTransaction hash
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get payment status by tx hash › Responses
Successful operation
successGet payment status by user operation hash
Retrieves information about a claim using the provided user operation hash
path Parameters
chainName of the chain
user_op_hashUser operation hash
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get payment status by user operation hash › Responses
Successful operation
successGet sender history
Get sender history by sender address
path Parameters
chainChain name
senderSender's ID
query Parameters
only_activeFilter by active status
offsetOffset for pagination
limitLimit for pagination
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get sender history › Responses
Successful response
successFlag indicating the success of the request.
Get dashboard link status
Retrieve transfer data for claim links generated via Linkdrop dashboard.
path Parameters
serverName of the server
transfer_idTransfer ID
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get dashboard link status › Responses
Successful response
successRedeem dashboard link
Redeem tokens for links generated via Linkdrop Dashboard.
path Parameters
serverName of the chain
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Redeem dashboard link › Request Body
receiverAddress of receiver
senderAddress of sender
escrowEscrow contract address
transfer_idTransfer ID
receiver_sigReceiver's signature
tokenAddress of token contract
Redeem dashboard link › Responses
Redeem successful
successIndicates if the transfer was successful
tx_hashHash of the transaction
Get redeemed deposits report
Retrieve info about redeemed deposits.
path Parameters
chainChain name
query Parameters
redeem_blocknumber_fromFilter deposits that have been redeemed and are greater than the specified block number.
offsetOffset for pagination. 0 by default
limitLimit for pagination. 100 by default
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get redeemed deposits report › Responses
Successful response
successFlag indicating the success of the request.
Get links count by sender
Returns counts retrieved based on status, token, and sender.
path Parameters
chainChain name
senderSender address
query Parameters
tokenToken address
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get links count by sender › Responses
Successful response
successFlag indicating the success of the request.
depositedCount of deposited links.
redeemedCount of redeemed links.
refundedCount of refunded links.
totalTotal number of results.