Skip to main content
Version: 1.2.0 - Production

Get Holding Statement

GET 
/v1.2/statement/positions

This is used to get the current position details of a given customer under a given account number.

Request​

Query Parameters

    year integerrequired

    only accepts current year or a previous year

    Example: 2022

    month integerrequired

    Possible values: >= 1 and <= 12

    if current year is given, month must be current month or a previous month

    customerNumber stringrequired

    Possible values: <= 20 characters

    accountNumber string

    Possible values: <= 50 characters

    Security account number

    contentType stringrequired

    currently only accepts json format

    Example: json

Header Parameters

    Throttle-Key string

Responses​

OK

Schema
    status stringrequired
    reason string
    rejectCode integer
    customerNumber string
    month integer
    year integer
    period string
    list object[]
  • Array [
    • accountNumber string
    securityType string

    Possible values: [CS, OPT, BND, FND]

    list object[]
  • Array [
    • exchangeAccountId string
    exchange string
    list object[]
  • Array [
    • symbol string
    totalHolding number

    This is only for equity, option and spot asset types.

    totalAmount number

    This is only for bond and fund asset types.

    list object[]
  • Array [
    • transactionDate string

    Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$

    narration string
    quantity number

    This is only for equity, option and spot asset types.

    amount number

    This is only for bond and fund asset types.

  • ]
  • ]
  • ]
  • ]
Loading...
Is this page helpful for you?
Last updated on