Market briefing
curl --request GET \
--url https://www.sharpe.ai/api/v1/briefing \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.sharpe.ai/api/v1/briefing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.sharpe.ai/api/v1/briefing"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"report": "briefing",
"report_md": "<string>",
"inputs": [
{
"label": "<string>",
"endpoint": "<string>",
"query": {},
"dataset_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"freshness_status": "fresh",
"runtime_status": "ok",
"error": "<string>"
}
]
},
"meta": {
"request_id": "req_a1b2c3d4e5f6g7h8i9j0",
"timestamp": "2023-11-07T05:31:56Z",
"elapsed_ms": 1,
"dataset_id": "funding_rates_current",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"runtime_status": "ok",
"served_from": "snapshot",
"generated_at": "2023-11-07T05:31:56Z",
"source": [
"<string>"
],
"coverage": {
"expected": 123,
"used": 123,
"dropped": {},
"missing": [
"<string>"
]
},
"warnings": [
"<string>"
],
"truncated": true
}
}Reports
Market briefing
A market briefing rendered as markdown: total market cap, 24h volume, BTC dominance and the Fear & Greed Index; the top 5 and bottom 3 narratives by 24h change as the API ranks them; the funding book’s highest and lowest markets by 8h-equivalent rate among fresh markets with at least $1M of open interest, printed as APR with each venue’s rate_kind (mostly the estimate of the next payment, not yet charged); and the whole-market funding estimated over the next 24 hours at current rates. inputs lists each read with the freshness of its answer; a read that fails leaves a gap in the report, not an error.
GET
/
v1
/
briefing
Market briefing
curl --request GET \
--url https://www.sharpe.ai/api/v1/briefing \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://www.sharpe.ai/api/v1/briefing', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://www.sharpe.ai/api/v1/briefing"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"report": "briefing",
"report_md": "<string>",
"inputs": [
{
"label": "<string>",
"endpoint": "<string>",
"query": {},
"dataset_id": "<string>",
"as_of": "2023-11-07T05:31:56Z",
"freshness_status": "fresh",
"runtime_status": "ok",
"error": "<string>"
}
]
},
"meta": {
"request_id": "req_a1b2c3d4e5f6g7h8i9j0",
"timestamp": "2023-11-07T05:31:56Z",
"elapsed_ms": 1,
"dataset_id": "funding_rates_current",
"as_of": "2023-11-07T05:31:56Z",
"stale_after": "2023-11-07T05:31:56Z",
"freshness_sla_seconds": 123,
"freshness_status": "fresh",
"runtime_status": "ok",
"served_from": "snapshot",
"generated_at": "2023-11-07T05:31:56Z",
"source": [
"<string>"
],
"coverage": {
"expected": 123,
"used": 123,
"dropped": {},
"missing": [
"<string>"
]
},
"warnings": [
"<string>"
],
"truncated": true
}
}Authorizations
BearerAuthApiKeyAuth

