SMsmallcase

smallcase order details

The API fetches smallcase order details based on the passed transactionId, batchId or iscid. The API provides information related to the smallcase order like name of the smallcase, broker name, information about the stock orders that were executed, quantities, orderType etc.

<<apiUseCaseTerm>>: This API is ideal when you want to display the user detailed information about the smallcase orders that were carried out.

get/{gatewayname}/engine/orders/smt

Request

  • Base URL
    https://gatewayapi.smallcase.com/v1
  • URL
    https://gatewayapi.smallcase.com/v1/{gatewayname}/engine/orders/smt
  • Auth
    none required

Path parameters

gatewaynamestring required

Query parameters

transactionIdstring[]

Optional | transactionId(s) for which you want to fetch order details

batchIdstring[]

Optional | batchId(s) for which you want to fetch order details

iscidstring

Optional | iscid for which you want to fetch order details

Headers

x-gateway-secretstring required

Required | apiSecret shared for authentication

x-gateway-authtokenstring required

Required | JWT signed with shared secret & payload for connected user or a guest user

Response

200

OR

Example response

{
  "success": true,
  "data": {
    "investedSmallcases": [
      {
        "name": "Low Risk - Smart Beta",
        "scid": "SCSB_0003",
        "userId": "5efb6006be924d440344199f",
        "source": "PROFESSIONAL",
        "broker": "kite-leprechaun",
        "batches": [
          {
            "label": "BUY",
            "originalLabel": "BUY",
            "status": "COMPLETED",
            "transactionId": "TRX_656f8e01f1f1459cbe2c23a871a47fce",
            "variety": "regular",
            "buyAmount": 57214.23,
            "completedDate": "2021-04-05T13:16:18.141Z",
            "quantity": 15,
            "filled": 15,
            "batchId": "606b0d9ebc70e538a519851e",
            "orders": [
              {
                "orderType": "MARKET",
                "product": "CNC",
                "exchange": "NSE",
                "status": "COMPLETE",
                "quantity": 2,
                "tradingsymbol": "ALKEM",
                "transactionType": "BUY",
                "filledQuantity": 2,
                "orderTimestamp": "2021-04-05T13:16:15.524Z",
                "averagePrice": 2774.84
              }
            ]
          }
        ],
        "iscid": "606b0d9ebc70e538a519851c",
        "imageUrl": "https://assets.smallcase.com/images/smallcases/200/SCSB_0003.png"
      }
    ],
    "broker": "kite-leprechaun",
    "authToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzbWFsbGNhc2VBdXRoSWQiOiI1ZWZjNjIxNzc5ZjYwMTViNWFkYjA5MTMiLCJpYXQiOjE2MjMwNzU4NzYsImV4cCI6MTYyMzcwNTg3Nn0.Nh3MN_vzTMGmeNYvkt_Fg-5B-rUQO5Z-uYRJMHTtTlw"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.