# STOCK SCREENING REPORT v.3

Get the screening results of Shariah-compliant stocks with comprehensive details. You can query by stock ticker.

## Request body:

| Parameter | Value | Description |
| --- | --- | --- |
| stock | “AAPL” | Stock symbol |

## Response body:

| Parameter | Type | Description |
| --- | --- | --- |
| companyName | string | Company name |
| symbol | string | Stock symbol |
| lastUpdate | string | Last update date in ISO 8601 Date/Time Format (YYYY-MM-DD). |
| shariahComplianceStatus | string | Shariah-compliance Status  (Halal, Not Halal, Doubtful, Not Covered) |
| complianceRanking | number | Compliance Rank (0-5) |
| revenueBreakdown | object |     Revenue Breakdown JSON Object  _{  "halalRatio": "number", // percentage value from 0 to 100  "notHalalRatio": "number", // percentage value from 0 to 100  "doubtfulRatio": "number", // percentage value from 0 to 100  "doubtfulRevenue": "number", // amount in units  "halalRevenue": "number", // amount in units  "notHalalRevenue": "number", // amount in units  "status": "string", // Pass or Fail  }_  Combined  revenue from DOUBTFUL and NOT HALAL sources must be less than 5% of  total revenue to be Shariah compliant based on AAOIFI stock screening  methodology.  Thus,    \- If DOUBTFUL+NOT HALAL revenue is equal or more than 5%, then the status will be FAIL  \- If DOUBTFUL+NOT HALAL revenue is less than 5%, then the status will be PASS  \- If HALAL, DOUBTFUL and NOT HALAL has no value, then the status will be NOT_UNDER_COVERAGE     |
| interestBearingSecuritiesAndAssets | object |     Interest-bearing Securities and Assets  Interest-Bearing  Securities and Assets should be less than 30% of Trailing 36-month  Average Market Capitalization to be Shariah compliant based on AAOIFI  stock screening methodology.Thus,    \- if Interest Ratio is equal or more than 30%, then the status will be ‘Fail’  \- if Interest Ratio is less than 30%, then the status will be ‘Pass’  \- if Interest Ratio has no value, then the status will be ’NOT_COVERED’     |
| interestBearingDebt | object |     Interest-bearing Debt  Interest-Bearing Debt should be less  than 30% of Trailing 36-Month Average Market Capitalization to be  Shariah compliant based on AAOIFI stock screening methodology.  Thus,    \- if Debt Ratio is equal or more than 30%, then the status will be ‘Fail’  \- if Debt Ratio is less than 30%, then the status will be ‘Pass’  \- if Debt Ratio has no value, then the status will be ’NOT_COVERED’     |
| reportDate | date | Reporting dates of the company in ISO 8601 Date/Time Format (YYYY-MM-DD). |
| reportSource | string | URL link to the company report. |
| totalRevenue | number | Total Revenue of the company |
| trailing36monAvrCap | number | Trailing 36-month Average Market Capitalization of the company. |
| totalAssets | number | Amount of Total Assets (in units) |
| accountsReceivable | number | Amount of Accounts Receivable (in units) |
| reportedYear | number | Reporting year |
| reportedQuarter | string | Reporting period (FIRST_QUARTER, SECOND_QUARTER, THIRD_QUARTER, ANNUAL) |
| mainCurrency | string | Reporting currency. Currency used in company filings |
| units | number | Number expression (e.g. in million) |
| revenueBreakdownDetail | object | Revenue breakdown JSON object that contains line items with  compliance type, ration, amount in once and comments.  _{ "amount": "number",  "amountInOnes": "number", "questionablePercentage": "number",  "halalPercentage": "number", "questionableAmountInOnes": "number",  "notHalalAmount": "number", "notHalalAmountInOnes": "number",  "halalAmountInOnes": "number", "percentage": "number", "name": "string",  "notHalalPercentage": "number", "halalAmount": "number", "items":  "array", "questionableAmount": "number" }_ |
| interestBearingSecuritiesAndAssetsDetail | object | Interest-bearing securities and assets JSON object that contains  line items with compliance type, ration, amount in once and comments.  _{ "totalAmount":"number", "totalRetio":"number", "longTermJson":"object",  "totalNonIslamicAmount":"number" "shortTermJson":"object" }_ |
| interestIncomeDetail | object | Interest Income JSON object that contains line items with compliance  type, ration, amount in once and comments.  _{ "amount":"number",  "amountInOnes":"number", "questionablePercentage":"number",  "halalPercentage":"number", "questionableAmountInOnes":"number",  "notHalalAmount":"number", "notHalalAmountInOnes":"number",  "halalAmountInOnes":"number", "percentage":"number", "name":"string",  "notHalalPercentage":"number", "halalAmount":"number", "items":"array",  "questionableAmount":"number" }_ |
| interestBearingDebtDetail | object | Interest-bearing debt JSON object that contains line items with  compliance type, ration, amount in once and comments.  _{ "totalAmount":"number", "totalRetio":"number", "longTermJson":"object",  "totalNonIslamicAmount":"number" "shortTermJson":"object" }_ |

Endpoint: POST /v3/musaffa/stocks/report
Version: 1.0.0
Security: MusaffaAuth

## Header parameters:

  - `clientid` (string)
    Example: "{{clientId}}"

  - `time` (string)
    Example: "{{time}}"

  - `token` (string)
    Example: "{{token}}"

## Request fields (application/json):

  - `stock` (string)
    Example: "AAPL"

## Response 200 fields (application/json):

  - `accountsReceivable` (number)
    Example: 23752

  - `companyName` (string)
    Example: "Apple Inc"

  - `complianceRanking` (number)
    Example: 1

  - `interestBearingDebt` (object)

  - `interestBearingDebt.amount` (number)
    Example: 111110000775.74251

  - `interestBearingDebt.ratio` (number)
    Example: 4.969386

  - `interestBearingDebt.status` (string)
    Example: "Pass"

  - `interestBearingDebtDetail` (object)

  - `interestBearingDebtDetail.longTermJson` (object)

  - `interestBearingDebtDetail.longTermJson.amountInOnes` (number)
    Example: 99627000000

  - `interestBearingDebtDetail.longTermJson.islamicAmount` (number)

  - `interestBearingDebtDetail.longTermJson.islamicAmountInOnes` (number)

  - `interestBearingDebtDetail.longTermJson.islamicPercentage` (number)

  - `interestBearingDebtDetail.longTermJson.items` (array)
    Example: [{"amount":"99627","amountInOnes":99627000000,"comment":"","id":"1","items":[],"itemsNotHalal":0,"itemsQuestionable":0,"name":"Term debt","percentage":4.4558097885406935,"selector":"NON_ISLAMIC"}]

  - `interestBearingDebtDetail.longTermJson.items.comment` (string)

  - `interestBearingDebtDetail.longTermJson.items.id` (string)
    Example: "1"

  - `interestBearingDebtDetail.longTermJson.items.itemsNotHalal` (number)

  - `interestBearingDebtDetail.longTermJson.items.itemsQuestionable` (number)

  - `interestBearingDebtDetail.longTermJson.items.name` (string)
    Example: "Term debt"

  - `interestBearingDebtDetail.longTermJson.items.percentage` (number)
    Example: 4.4558097885406935

  - `interestBearingDebtDetail.longTermJson.items.selector` (string)
    Example: "NON_ISLAMIC"

  - `interestBearingDebtDetail.longTermJson.nonIslamicAmount` (number)
    Example: 99627

  - `interestBearingDebtDetail.longTermJson.nonIslamicAmountInOnes` (number)
    Example: 99627000000

  - `interestBearingDebtDetail.longTermJson.nonIslamicPercentage` (number)
    Example: 89.66519665196653

  - `interestBearingDebtDetail.longTermJson.retio` (number)
    Example: 4.4558097885406935

  - `interestBearingDebtDetail.shortTermJson` (object)

  - `interestBearingDebtDetail.totalAmount` (number)
    Example: 111110

  - `interestBearingDebtDetail.totalNonIslamicAmount` (number)
    Example: 111110

  - `interestBearingDebtDetail.totalRetio` (number)
    Example: 4.96938606607402

  - `interestBearingSecuritiesAndAssets` (object)

  - `interestBearingSecuritiesAndAssetsDetail` (object)

  - `interestIncomeDetail` (object)

  - `interestIncomeDetail.halalAmount` (number)

  - `interestIncomeDetail.halalAmountInOnes` (number)

  - `interestIncomeDetail.halalPercentage` (number)

  - `interestIncomeDetail.notHalalAmount` (number)
    Example: 868

  - `interestIncomeDetail.notHalalAmountInOnes` (number)
    Example: 868000000

  - `interestIncomeDetail.notHalalPercentage` (number)
    Example: 0.7354561014048229

  - `interestIncomeDetail.questionableAmount` (number)

  - `interestIncomeDetail.questionableAmountInOnes` (number)

  - `interestIncomeDetail.questionablePercentage` (number)

  - `lastUpdate` (string)
    Example: "2023-05-16T10:26:12.034710Z"

  - `mainCurrency` (string)
    Example: "USD"

  - `reportDate` (string)
    Example: "2022-12-31"

  - `reportPeriod` (number)
    Example: 91

  - `reportSource` (string)

  - `reportedQuarter` (string)
    Example: "FIRST_QUARTER"

  - `reportedYear` (number)
    Example: 2023

  - `revenueBreakdown` (object)

  - `revenueBreakdown.doubtfulRatio` (number)
    Example: 3.3891985

  - `revenueBreakdown.doubtfulRevenue` (number)
    Example: 3999999902.815819

  - `revenueBreakdown.halalRatio` (number)
    Example: 95.88

  - `revenueBreakdown.halalRevenue` (number)
    Example: 113159493600

  - `revenueBreakdown.notHalalRatio` (number)
    Example: 0.7354561

  - `revenueBreakdown.notHalalRevenue` (number)
    Example: 868000009.0193748

  - `revenueBreakdownDetail` (object)

  - `shariahComplianceStatus` (string)
    Example: "HALAL"

  - `symbol` (string)
    Example: "AAPL"

  - `totalAssets` (number)
    Example: 346747

  - `totalRevenue` (number)
    Example: 118022000000

  - `trailing36monAvrCap` (number)
    Example: 2235889876992

  - `units` (number)
    Example: 1000000