WebSocket

Get Deposit Addresses

Returns an array of the user's deposit addresses, both fiat and crypto.

Auth:API Key

Tags:

Funding

Deposits

Command Name

GetDepositAddress

Command Arguments

Field	Type	Required	Description
`ClientId`	string	Required	Custom client ID for tracking (max 36 characters) Example: `"my-client-123"`

ClientId

Required

Type:

string

Description:

Custom client ID for tracking (max 36 characters)

Example: "my-client-123"

Command Invocation

Command Arguments Example:

[
  "my-client-123"
]

Invocation Example:

connection.invoke('GetDepositAddress', 'my-client-123')

Response Event

Event Name

executionEvents

Subject

account.internalAddresses.snapshot

Deposit addresses snapshot response containing an array of address records

Field	Type	Description
`id`	string	Address ID
`name`	string	Address name
`userId`	string	User ID
`endUserId`	string \| null	End user ID if applicable
`asset`	string	Asset name
`address`	string	Address
`addressParams`	object	Address parameters
`network`	string	Address network
`deleted`	boolean	Deleted flag
`creationDate`	string	Datetime of address creation
`refAccountId`	string \| null	Reference account ID if applicable
`refAccountType`	string \| null	Reference account type if applicable
`refAccountDetails`	object \| null	Additional details for the reference account

Example Response

{
  "data": [
    {
      "id": "xxxx",
      "name": "EUR",
      "userId": "yyyy",
      "endUserId": "eus_987654321",
      "asset": "EUR",
      "address": "zzzz",
      "addressParams": {},
      "network": "Sepa",
      "deleted": false,
      "creationDate": "0001-01-01T00:00:00",
      "refAccountId": "vac_123456789",
      "refAccountType": "VIRTUAL_ACCOUNT",
      "refAccountDetails": {
        "bankName": "Deutsche Bank",
        "accountHolderName": "John Doe",
        "country": "DE",
        "accountNumber": "532013000",
        "routingCodes": [
          {
            "type": "sort_code",
            "value": "123456"
          }
        ],
        "iban": "DE89370400440532013000",
        "bic": "COBADEFFXXX"
      }
    },
    {
      "id": "aaaa",
      "name": "BTC",
      "userId": "bbbb",
      "endUserId": null,
      "asset": "BTC",
      "address": "cccc",
      "addressParams": {},
      "network": "Bitcoin",
      "deleted": false,
      "creationDate": "0001-01-01T00:00:00",
      "refAccountId": null,
      "refAccountType": null,
      "refAccountDetails": null
    }
  ]
}

Code Examples

const signalR = require('@microsoft/signalr');

const apiKey = 'YOUR_API_KEY_HERE';
const connection = new signalR.HubConnectionBuilder()
  .withUrl('https://publicapi.sandbox.hercle.financial/ExecutionLiveServer/v1', {
    accessTokenFactory: () => apiKey,
  })
  .build();

connection.start()
  .then(() => {
    console.log('Connected to WebSocket');
    
    // Invoke command
    connection.invoke('GetDepositAddress', "my-client-123")
      .then(() => {
        console.log('Command sent successfully');
      })
      .catch(err => {
        console.error('Command failed:', err);
      });
  })
  .catch(err => {
    console.error('Connection failed:', err);
  });

// Listen for events
connection.on('executionEvents', (data) => {
  console.log('Received event:', data);
});

SignalR API Tester

Test this command in the sandbox environment

Disconnected

Sandbox API Key

Your API key is only used locally and never stored

Event Log

No events yet. Connect and invoke a command to see events.