API Docs - Sharlife API Developer Portal

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.

API Reference

List Crypto Assets

Returns a lightweight summary list of crypto assets ordered by market cap.

GET /crypto/v1/list

Availability

Plan	Access	Notes
`Free Trial`	Yes	Limit to top 50 market cap.

Authorizations

x-api-key

string header required

Get API key via https://dev.sharlife.my/api-keys

Query Parameters

This endpoint does not require any query parameters.

Response

This endpoint is intentionally lightweight. Use /crypto/v1/info for the full screening record.

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.
`quote`	object	Price, market cap, volume, and 24h change.

List Crypto Assets

curl --request GET \
  --url https://api.sharlife.my/crypto/v1/list \
  --header 'x-api-key: shl_api_...'

import requests

response = requests.get(
    "https://api.sharlife.my/crypto/v1/list",
    headers={"x-api-key": "shl_api_..."},
)

print(response.json())

const response = await fetch("https://api.sharlife.my/crypto/v1/list", {
  method: "GET",
  headers: {
    "x-api-key": "shl_api_...",
  },
});

const data = await response.json();
console.log(data);

<?php

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.sharlife.my/crypto/v1/list",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "x-api-key: shl_api_..."
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.sharlife.my/crypto/v1/list", nil)
    req.Header.Set("x-api-key", "shl_api_...")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sharlife.my/crypto/v1/list"))
    .header("x-api-key", "shl_api_...")
    .GET()
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://api.sharlife.my/crypto/v1/list")
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "shl_api_..."

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

Response 200

{
  "success": true,
  "data": {
    "items": [
      {
        "name": "Ethereum",
        "name_id": "ethereum",
        "ticker": "ETH",
        "shariah_status": "shariah",
        "quote": {
          "price": 2062.6679270352165,
          "market_cap": 248946053761.99472,
          "volume_24h": 14625203852.432085,
          "percent_change_24h": 0.65612667,
          "last_updated": "2026-04-03T06:58:00.000Z"
        }
      }
    ]
  }
}

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	Notes
`Free Trial`	Yes	Limit to top 50 market cap.

Authorizations

x-api-key

string header required

Get API key via https://dev.sharlife.my/api-keys

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.

Get Crypto Info

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

import requests

response = requests.get(
    "https://api.sharlife.my/crypto/v1/info",
    headers={"x-api-key": "shl_api_..."},
    params={"name_id": "ethereum"},
)

print(response.json())

const response = await fetch(
  "https://api.sharlife.my/crypto/v1/info?name_id=ethereum",
  {
    method: "GET",
    headers: {
      "x-api-key": "shl_api_...",
    },
  }
);

const data = await response.json();
console.log(data);

<?php

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.sharlife.my/crypto/v1/info?name_id=ethereum",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "x-api-key: shl_api_..."
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.sharlife.my/crypto/v1/info?name_id=ethereum", nil)
    req.Header.Set("x-api-key", "shl_api_...")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sharlife.my/crypto/v1/info?name_id=ethereum"))
    .header("x-api-key", "shl_api_...")
    .GET()
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://api.sharlife.my/crypto/v1/info?name_id=ethereum")
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "shl_api_..."

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

Response 200

{
  "success": true,
  "data": {
    "name": "Ethereum",
    "name_id": "ethereum",
    "ticker": "ETH",
    "shariah_status": "shariah",
    "consensus_mechanism": "Proof of Stake",
    "analysis": "As of now, the projects provided by Ethereum appear to be in accordance with Shariah principles.",
    "whitepaper_link": "https://github.com/ethereum/wiki/wiki/White-Paper",
    "in_depth_analysis": {
      "legitimacy": {
        "team": {
          "detail": "Ethereum's team is comprised of qualified experts in blockchain, cryptography, and software development.",
          "status": "passed"
        },
        "whitepaper": {
          "detail": "Ethereum provides well-documented technical resources and project goals.",
          "status": "passed"
        },
        "project": {
          "detail": "Ethereum maintains transparent updates across official channels.",
          "status": "passed"
        },
        "additional_info": ""
      },
      "project": {
        "data": [
          [
            "Blockchain",
            "Ethereum provides a decentralized ledger for secure and transparent transactions.",
            "passed"
          ],
          [
            "Smart Contracts",
            "Ethereum supports programmable smart contracts through Solidity.",
            "passed"
          ]
        ],
        "additional_info": ""
      }
    },
    "last_screening": {
      "quater": "Q2",
      "year": "2024"
    },
    "about": "Ethereum (ETH) is a cryptocurrency...",
    "others_document": [],
    "overview": "Ethereum is a blockchain platform for decentralized applications and smart contracts.",
    "quote": {
      "price": 2062.6679270352165,
      "volume_24h": 14625203852.432085,
      "cex_volume_24h": 14531948893.942127,
      "dex_volume_24h": 93254958.48996834,
      "volume_change_24h": -31.4976,
      "percent_change_1h": 0.28548653,
      "percent_change_24h": 0.65612667,
      "percent_change_7d": 0.06541358,
      "percent_change_30d": 4.1977557,
      "percent_change_60d": -7.16087406,
      "percent_change_90d": -33.47935668,
      "market_cap": 248946053761.99472,
      "market_cap_dominance": 10.8092,
      "fully_diluted_market_cap": 248946053761.99,
      "tvl": null,
      "last_updated": "2026-04-03T06:58:00.000Z",
      "volume": 14625203852.432085
    }
  }
}

API Reference

List Stocks

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

GET /stock/v1/list

Availability

Plan	Access	Notes
`Free Trial`	No

Authorizations

x-api-key

string header required

Get API key via https://dev.sharlife.my/api-keys

Query Parameters

This endpoint does not require any query parameters.

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.

List Stocks

curl --request GET \
  --url https://api.sharlife.my/stock/v1/list \
  --header 'x-api-key: shl_api_...'

import requests

response = requests.get(
    "https://api.sharlife.my/stock/v1/list",
    headers={"x-api-key": "shl_api_..."},
)

print(response.json())

const response = await fetch("https://api.sharlife.my/stock/v1/list", {
  method: "GET",
  headers: {
    "x-api-key": "shl_api_...",
  },
});

const data = await response.json();
console.log(data);

<?php

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.sharlife.my/stock/v1/list",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "x-api-key: shl_api_..."
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.sharlife.my/stock/v1/list", nil)
    req.Header.Set("x-api-key", "shl_api_...")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sharlife.my/stock/v1/list"))
    .header("x-api-key", "shl_api_...")
    .GET()
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://api.sharlife.my/stock/v1/list")
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "shl_api_..."

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

Response 200

{
  "success": true,
  "data": {
    "items": [
      {
        "ticker": "V",
        "stock_id": "visa-inc",
        "name": "Visa Inc.",
        "country": "US",
        "market": "US",
        "exchange": {
          "name": "NYSE"
        },
        "sector": ["Finance"],
        "main_business": "Payments Technology and Processing",
        "type": "Common Stock",
        "shariah": {
          "fiscal_year": "2025",
          "source": "aaoifi",
          "shariah_status": "passed"
        }
      }
    ]
  }
}

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	Notes
`Free Trial`	No

Authorizations

x-api-key

string header required

Get API key via https://dev.sharlife.my/api-keys

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 decision by fiscal year. Years without `shariah_status` are excluded.

Get Stock Info

curl --request GET \
  --url 'https://api.sharlife.my/stock/v1/info?stock_id=apple-inc' \
  --header 'x-api-key: shl_api_...'

import requests

response = requests.get(
    "https://api.sharlife.my/stock/v1/info",
    headers={"x-api-key": "shl_api_..."},
    params={"stock_id": "apple-inc"},
)

print(response.json())

const response = await fetch(
  "https://api.sharlife.my/stock/v1/info?stock_id=apple-inc",
  {
    method: "GET",
    headers: {
      "x-api-key": "shl_api_...",
    },
  }
);

const data = await response.json();
console.log(data);

<?php

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://api.sharlife.my/stock/v1/info?stock_id=apple-inc",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "x-api-key: shl_api_..."
    ],
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://api.sharlife.my/stock/v1/info?stock_id=apple-inc", nil)
    req.Header.Set("x-api-key", "shl_api_...")

    resp, _ := http.DefaultClient.Do(req)
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.sharlife.my/stock/v1/info?stock_id=apple-inc"))
    .header("x-api-key", "shl_api_...")
    .GET()
    .build();

HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());

System.out.println(response.body());

require "net/http"
require "uri"

uri = URI("https://api.sharlife.my/stock/v1/info?stock_id=apple-inc")
request = Net::HTTP::Get.new(uri)
request["x-api-key"] = "shl_api_..."

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

Response 200

{
  "success": true,
  "data": {
    "ticker": "AAPL",
    "country": "US",
    "market": "US",
    "exchange": {
      "name": "NASDAQ"
    },
    "name": "Apple Inc.",
    "sector": [
      "Electronic technology"
    ],
    "stock_id": "apple-inc",
    "revenue_breakdown": {
      "2025": {
        "manual": {
          "total_value": 416161.0,
          "total_nsc": 32747.4,
          "total_unit": "M",
          "nsc_perc": 7.9,
          "shariah_status": "failed",
          "annual_info": {
            "fiscal_year": "2025",
            "fiscal_end_date": "",
            "link": ""
          },
          "operating_income": [
            {
              "segment": "iPhone",
              "value": 209586.0,
              "unit": "M",
              "currency": "USD",
              "nsc": 0,
              "reason": ""
            },
            {
              "segment": "Services",
              "value": 109158.0,
              "unit": "M",
              "currency": "USD",
              "nsc": 32747.4,
              "reason": "Advertising and Streaming"
            }
          ],
          "non_operating_income": []
        }
      }
    },
    "industry": {},
    "main_business": "Consumer Electronics and Technology",
    "type": "Common Stock",
    "financial": {
      "2025": {
        "fiscal_date": "30/09/2025",
        "shares_outstanding": 14773260000,
        "fiscal_price": {
          "price": 254.38,
          "currency": "USD",
          "date": "30/09/2025"
        },
        "market_cap": {
          "market_cap": 3758021878800,
          "currency": "USD"
        },
        "liabilities": {
          "aaoifi": {
            "total_non_shariah": {
              "value": 98657000000,
              "currency": "USD"
            },
            "non_shariah_percentage": 2.625237510099405,
            "shariah_status": "passed"
          }
        },
        "cash": {
          "aaoifi": {
            "total_non_shariah": {
              "value": 54697000000,
              "currency": "USD"
            },
            "non_shariah_percentage": 1.4554731655118964,
            "shariah_status": "passed"
          }
        }
      }
    },
    "final_shariah": {
      "2025": {
        "source": "aaoifi",
        "aaoifi": {
          "shariah_status": "failed",
          "reason": ["Revenue Breakdown Failed"]
        }
      }
    }
  }
}