Docs

Sharlife API

Create an account, copy your API key, and start with crypto status data through the Sharlife API.

Introduction

The Sharlife API is organized around REST. Our API uses predictable resource-oriented URLs, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Current API scope

The current API provides read-only access to Shariah-screened crypto and stock data, depending on your plan access.

Base URL

All API requests are made against https://api.sharlife.my.

Authentication

The Sharlife API uses API keys to authenticate requests. You can view and manage your API keys in the Sharlife Developer Portal.

API key format

Current API keys use the prefix shl_api_.

Keep your key secure

Do not share your API key in public repositories, client-side code, or any publicly accessible area.

Accepted authentication headers

Authentication can be performed with x-api-key. The API also accepts Authorization: Bearer <api_key>.

HTTPS required

All API requests must be made over HTTPS. Requests made without authentication will fail.

Quick start

Free access includes crypto status lookups for the top 50 assets. Use ethereum for your first request.

curl --request GET \
  --url 'https://api.sharlife.my/crypto/v1/status?name_id=ethereum' \
  --header 'x-api-key: shl_api_...'
API Reference

List Crypto Assets

Returns a paginated directory of supported crypto assets.

GET /crypto/v1/list

Availability

Plan Access
Free No
Builder and above Yes

Authorizations

x-api-key
string header required

View your API keys in the developer dashboard.

Query Parameters

Use optional page and limit parameters. The response includes pagination.has_more and pagination.next_page.

Response

This endpoint returns identifiers only. Use /crypto/v1/status for an asset's current status or /crypto/v1/info for its full screening record.

Field Type Description
name string Asset display name.
name_id string Stable asset identifier.
ticker string Asset symbol.
API Reference

Get Crypto Info

Returns the detailed Shariah screening document for a single asset using name_id.

GET /crypto/v1/info

Availability

Plan Access
Builder and below No
Scale and above Yes

Authorizations

x-api-key
string header required

View your API keys in the developer dashboard.

Query Parameters

Query Type Required Description
name_id string Yes The asset identifier, for example ethereum.

Response

This endpoint returns the full screening record, including analysis blocks and deep project metadata.

Field Type Description
name string Asset display name.
name_id string Stable asset identifier.
ticker string Asset symbol.
shariah_status string Current Shariah status label.
consensus_mechanism string | null Consensus mechanism metadata.
analysis string Primary Shariah screening explanation.
whitepaper_link string | null Whitepaper URL from the source record.
in_depth_analysis object Detailed legitimacy, project, token, and reward analysis.
last_screening object Latest screening quarter and year.
about string | null Project background and source summary.
others_document array Additional related source documents.
overview string | null Human-readable project summary.
quote object Current market metrics subset from the source record.
API Reference

Get Crypto Status

Returns only the current Shariah status for a single crypto asset using name_id.

GET /crypto/v1/status

Availability

Plan Access
Free Yes
Builder and above Yes

Authorizations

x-api-key
string header required

View your API keys in the developer dashboard.

Query Parameters

Query Type Required Description
name_id string Yes The asset identifier, for example ethereum.

Response

A lightweight response containing the requested asset identifier and its current Shariah status.

Field Type Description
name_id string Stable asset identifier.
ticker string Crypto asset ticker symbol.
shariah_status string Current Shariah screening status.
API Reference

List Crypto Statuses

Returns the current Shariah status catalogue for available v2 crypto assets, one cursor-based page at a time.

GET /crypto/v1/statuses

Availability

Plan Access
Builder and below No
Scale and above Yes

Authorizations

x-api-key
string header required

Use an API key with the bulk_crypto_status entitlement.

Query Parameters

Use limit to choose a page size and pass the returned next_cursor to continue from the next record.

Response

Items are ordered alphabetically by name_id. Cursors are opaque and should be used exactly as returned.

Field Type Description
data.items array Complete, recognized v2 crypto status records for this page.
name_id string Stable asset identifier.
ticker string Crypto asset ticker symbol.
shariah_status string One of shariah, non-shariah, or grey.
API Reference

Get Stock Status

Returns the current Shariah status for one stock using stock_id.

GET /stock/v1/status

Availability

Plan Access
Free No
Builder and above Yes

Authorizations

x-api-key
string header required

View your API keys in the developer dashboard.

Query Parameters

Query Type Required Description
stock_id string Yes The stock identifier, for example apple-inc.

Response

Returns the stock identifier, ticker, and normalized Shariah status.

API Reference

List Stocks

Returns a lightweight summary list of stocks ordered by market cap.

GET /stock/v1/list

Availability

Plan Access
Builder and below No
Scale and above Yes

Authorizations

x-api-key
string header required

View your API keys in the developer dashboard.

Query Parameters

Use optional page and limit parameters. The response includes pagination.has_more and pagination.next_page.

Response

This endpoint returns a lighter stock summary. Use /stock/v1/info for the full screening record.

Field Type Description
ticker string Stock ticker symbol.
stock_id string Stable stock identifier.
name string Company display name.
exchange object Exchange name metadata.
sector array Assigned sector labels from the source record.
shariah object Latest final Shariah outcome summary.
API Reference

Get Stock Info

Returns the detailed Shariah screening document for a single stock using stock_id.

GET /stock/v1/info

Availability

Plan Access
Builder and below No
Scale and above Yes

Authorizations

x-api-key
string header required

View your API keys in the developer dashboard.

Query Parameters

Query Type Required Description
stock_id string Yes The stock identifier, for example apple-inc.

Response

This endpoint returns a structured stock screening record with selected financial and Shariah fields.

Field Type Description
ticker string Stock ticker symbol.
country string Country code.
exchange object Exchange name metadata.
market string Market code.
name string Company display name.
sector array Assigned sector labels.
stock_id string Stable stock identifier.
revenue_breakdown object Revenue screening data with ai sections removed.
industry object Industry classification and non-compliant industry markers.
main_business string Main business summary.
type string Security type.
financial object Yearly financial screening data, including liabilities and cash ratios.
final_shariah object Final Shariah screening result by fiscal year. Years without shariah_status are excluded.