Who am I
curl --request GET \
--url https://api.halal.sh/v1/me \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.halal.sh/v1/me"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.halal.sh/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.halal.sh/v1/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.halal.sh/v1/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.halal.sh/v1/me")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"auth": "api_key",
"plan": "free",
"sandbox": true,
"key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "hsh_live_d102",
"type": "sandbox",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"limits": {
"requests_per_day": 2000,
"requests_per_minute": 120,
"evidence_packets_per_month": 123
},
"usage": {
"date": "2023-12-25",
"requests_today": 142,
"mcp_requests_today": 20
}
},
"meta": {
"request_id": "req_abc123",
"as_of": "2023-11-07T05:31:56Z",
"methodology": "aaoifi-ss21@2026.1"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Daily request limit (100) exceeded. Resets at midnight UTC.",
"retry_after": 3600
},
"meta": {
"request_id": "req_abc123"
}
}Account
Who am I
The caller’s plan, the key that authenticated (when one did), the limits that apply, and today’s request count split into direct and MCP traffic.
plan follows the caller’s current subscription, not the key
type: a live key on a lapsed plan reports plan: free and
sandbox: true, which is the fastest way to tell a lapsed plan from a
bad key without opening the dashboard.
GET
/
me
Who am I
curl --request GET \
--url https://api.halal.sh/v1/me \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.halal.sh/v1/me"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.halal.sh/v1/me', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.halal.sh/v1/me",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.halal.sh/v1/me"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.halal.sh/v1/me")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.halal.sh/v1/me")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"auth": "api_key",
"plan": "free",
"sandbox": true,
"key": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"prefix": "hsh_live_d102",
"type": "sandbox",
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z"
},
"limits": {
"requests_per_day": 2000,
"requests_per_minute": 120,
"evidence_packets_per_month": 123
},
"usage": {
"date": "2023-12-25",
"requests_today": 142,
"mcp_requests_today": 20
}
},
"meta": {
"request_id": "req_abc123",
"as_of": "2023-11-07T05:31:56Z",
"methodology": "aaoifi-ss21@2026.1"
}
}{
"error": {
"code": "unauthorized",
"message": "Invalid or revoked API key."
},
"meta": {
"request_id": "req_abc123"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Daily request limit (100) exceeded. Resets at midnight UTC.",
"retry_after": 3600
},
"meta": {
"request_id": "req_abc123"
}
}
