Skip to main content
GET
Search instruments
Search returns stocks and ETFs. Every item has a type field to branch on:
  • type: "stock": has a compliance status (compliant, non-compliant or pending) and last_analyzed_at.
  • type: "etf": has the fund’s Shariah purity (purity_percentage and badge_color) and match_coverage_percent, and no status field: a fund’s purity is a percentage, not a compliant or non-compliant verdict. For the fund’s purity breakdown, call Get ETF.
match_coverage_percent is the share of the fund’s weight in holdings we matched to an instrument in our catalog. A matched holding may not be screened yet, so don’t present it as ”% screened”. purity_percentage and badge_color are null until we have screened the fund.

Filtering by type

The optional types query parameter narrows results to one kind:
  • types=stock: stocks only.
  • types=etf: ETFs only.
  • Omitted: both.
types takes a comma-separated list (types=stock,etf), and any value other than stock or etf returns 400 Bad Request.

Authorizations

X-API-Key
string
header
required

Query Parameters

q
string
required

Search query (ticker or company/fund name).

Minimum string length: 1
Example:

"nvidia"

limit
integer
default:10
Required range: 1 <= x <= 100
types
string

Comma-separated instrument-type filter. Allowed values: stock, etf. Omitted returns both. Any unrecognized value returns 400.

Example:

"stock"

Response

Search results

data
object[]

A stock search hit. Carries the compliance status.

meta
object