GET

Deposits

GET /deposits

const getDeposits = () => {
  const body = {}
  const timestamp = Math.round(Date.now() / 1000)
  const payload = timestamp + 'GET' + '/deposits' + '{}'
  const decodedSecret = Buffer.from(apiSecret, 'base64')
  const hmac = crypto.createHmac('sha256', decodedSecret)
  const signedPayload = hmac.update(payload).digest('base64')

  // SET HEADERS
  const headers = {
    'X-NDAX-API-KEY': 'public_key',
    'X-NDAX-SIGNED': signedPayload,
    'X-NDAX-TIMESTAMP': timestamp,
    'X-NDAX-PASSPHRASE': 'passphrase'
  }
  const options = {
    headers,
    body,
    json: true
  }

  return request.get('https://api.ndax.in/deposits', options)
}

Sample Response

{
  "message": [
    {
      "settle_timestamp": 1590663417000,
      "account_id": "80289ce5-072b-4739-929d-dcc5ccc542f3",
      "movement_id": "21bdbb11-712f-4cb7-a178-4f277c80cde0",
      "participant_code": "ABC123",
      "account_group": "00SCXM",
      "account_label": "general",
      "asset": "BTC",
      "amount": "4.0000",
      "reference_id": "408482348dcb0e0331a9148d50f8c76db08138f63fb1586fcfc45200a91ccc5f",
      "source": "tb1qne1pq8yampg83w4d5ywc79frdrub0az9eqpq9w",
      "received_address": "tb1qf9bd2891mfhhz87o6ibairn86tadctgcn822pl",
      "run_id": "12613"
    }
  ],
  "page": 1,
  "total_pages": 1
}

Returns an array of deposits associated with the participant requesting. If you'd like to view your customer deposits in addition to yours, use the include_customer_deposits query parameter.

Query parameters include:

• page (optional) for paginating through your list of addresses

• asset (optional) will filter to a specific asset

• include_customer_deposits (optional) if true, will return customer deposits in addition to platform deposits

• settle_timestamp filters deposits based on a given timestamp in milliseconds 1593798130060 or nanoseconds 1593798130060000000 using the following next params for the following filter types:

  • [gt] greater than a given timestamp, e.g. settle_timestamp[gt]=1593798130060

  • [gte] greater than or equal to a given timestamp, e.g. settle_timestamp[gte]=1593798130060

  • [e] equal to a given timestamp, e.g. settle_timestamp[e]=1593798130060

  • [lt] less than a given timestamp, e.g. settle_timestamp[lt]=1593798130060

  • [lte] lower than or equal to a given timestamp, e.g. settle_timestamp[lte]=1593798130060

  • combinations are also possible, e.g. to find a trades between 1593798130555 and 1593798130777 you can use the next combination settle_timestamp[gt]=1593798130555&settle_timestamp[lt]=1593798130777

Response:

Parameter	Description	Type
settle_timestamp	The timestamp for when the deposit was credited to the participant - this is also the movement_timestamp	timestamp
movement_id	A unique ID for the specific account update	string
account_id	Unique ID of the specific account	string
participant_code	The participant that was credited with the deposit, e.g. ABCDEF	string
account_group	The account group associated with the account_id that received the deposit, e.g. 00SCXM for the Seed Digital Commodities Market account group	string
account_label	The account label associated with the account	string
asset	The asset code for the request, e.g. BTC	string
amount	The amount that was deposited into the account	number
reference_id	This is an external identifier associated with the deposit, which is context-specific depending on the asset type and deposit source - wire, transfer or on-chain transaction ID	string
source	The bank into which the fiat deposit was made or the blockchain address from which the crypto deposit came	string
received_address	The blockchain address to which the crypto deposit went	string
run_id	A unique ID for the particular run	string