DepositAddressService

List Deposit Addresses

List known deposit addresses for one account target.

Method

GET

Path

/v1/chain/deposit-addresses

Visibility

Authentication required

Authentication

Session token or API key

MFA Requirement

Not required

GET

/v1/chain/deposit-addresses

Request

Testnet

curl --request GET \ \
  --url 'https://api.testnet.polyester.com/v1/chain/deposit-addresses?chainId=1&subaccountId=45LUmqjT' \
  --header 'Accept: */*' \
  --header 'X-API-KEY-ID: YOUR_API_KEY_ID' \
  --header 'X-API-TIMESTAMP: YOUR_API_TIMESTAMP' \
  --header 'X-API-SIGNATURE: YOUR_API_SIGNATURE'

Responses

{
  "depositAddresses": [
    {
      "chainId": 1,
      "depositAddress": "0x7777777777777777777777777777777777777777"
    }
  ]
}

chainId integer > 0

Optional PolyChain-registered source chain id filter. When omitted, the response returns the known deposit addresses for the selected target on chains that currently accept deposits, ordered by ascending chain id. A chain whose deposits are unavailable returns FailedPrecondition.

subaccountId string (int64) > 0

Optional public subaccount ID. When omitted, subaccount-scoped API keys use their bound subaccount; other callers use their authenticated root account.

2 fields

Possible errors: 5

Key	HTTP status	Connect code	Error	When
unauthenticated	401	unauthenticated	Unauthenticated	Authentication required.
permission-denied	403	permission_denied	Permission Denied	Permission denied.
invalid-argument	400	invalid_argument	Invalid Argument	Invalid argument.
not-found	404	not_found	Not Found	Not found.
unavailable	503	unavailable	Unavailable	Service unavailable.