Get Shariah Compliant Symbols

GET 
/v1.2/master-data/symbols/sharia

This endpoint gives the Shariah compliant symbols for the given exchange.

clientClassification based filtering is currently only available in MENA region.

Request

Query Parameters

exchange stringrequired
symbol string

This is optional. If not present response will include all the Shariah compliant symbols for the given exchange. If present response will indicate whether it's Shariah compliant or not.

clientClassification integer

Possible values: [0, 1]

O ; General Symbol, 1 ; Client Compliant Symbol

This is optional. If not present, response will include both general and client compliant symbol data.

Header Parameters

Throttle-Key string

Responses

200

OK

application/json

Schema

Schema

status stringrequired
reason stringrequired
rejectCode integerrequired

Find error codes here

list object[]
Array [
symbol string
shariahCompliant integer
Possible values: [0, 1]
O ; not a Sharia compliant symbol, 1 ; Sharia compliant symbol
]

Example (from schema)

{
  "status": "string",
  "reason": "string",
  "rejectCode": 0,
  "list": [
    {
      "symbol": "string",
      "shariahCompliant": 0
    }
  ]
}

example

{
  "status": "SUCCESS",
  "reason": "sharia symbol list fetched",
  "rejectCode": 0,
  "list": [
    {
      "symbol": "AGG",
      "shariahCompliant": 1
    },
    {
      "symbol": "ZZI",
      "shariahCompliant": 1
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.2/master-data/symbols/sharia",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.2/master-data/symbols/sharia",
  "rejectCode": "1007"
}

Loading...