GET

GET /participants

const getParticipants = () => {
  const timestamp = Math.round(Date.now() / 1000)
  const payload = timestamp + 'GET' + '/participants' + '{}'
  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/participants', options)
}

Sample Response

{
  "message": [
    {
      "participant_code": "123XYZ",
      "custodian_participant_code": "CUST01",
      "participant_name": "Digicash LLP",
      "credit_limit": "50000",
      "status": "approved",
      "email": "admin@digicash.com"
    },
    {
      "participant_code": "ABC456",
      "participant_name": "Bits LLP",
      "credit_limit": null,
      "status": "approved",
      "email": null
    }
  ],
  "page": 1,
  "total_pages": 1,
  "page_size": 50,
  "count": 2
}

Returns a list of all participants to which you are associated.

Query parameters include:

  • email (optional) filters to a particular email

  • participant_code (optional) filters to a particular participant code

  • page (optional) for paginating through the participants

  • minors (optional) [true or false] if true, returns a list of minors and their associated custodians

  • status (optional) the current status of the participant.

Response parameters listed below

ParameterDescriptionType

participant_code

Unique participant code

string

custodian_participant_code

Unique participant code of the associated custodian

string

participant_name

Name of participant

string

credit_limit

Client-determined credit limit. used purely for reporting purposes at this time

string

email

Email associated with the participant. If the participant is institutional, this field will be null

string

status

The current status of the participant. read more about statuses here

string

Last updated