curl --request GET \
--url https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id} \
--header 'X-Blockworks-API-Key: <api-key>'import requests
url = "https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}"
headers = {"X-Blockworks-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Blockworks-API-Key': '<api-key>'}};
fetch('https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}', 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.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}",
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-Blockworks-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.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Blockworks-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.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}")
.header("X-Blockworks-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Blockworks-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"entity": {
"name": "<name>",
"slug": "<slug>"
},
"key": "<Project Revenue ID>",
"point_schema": [
{
"description": "Timestamp of the data point.",
"field": "time",
"name": "Time",
"time": true,
"type": "time"
},
{
"description": "Gross revenue in USD; negative on some days.",
"field": "grossRevenueUSD",
"name": "Gross Revenue (USD)",
"time": false,
"type": "float64"
},
{
"description": "Contra revenue in USD, deducted from gross revenue to give net revenue.",
"field": "contraRevenueUSD",
"name": "Contra Revenue (USD)",
"time": false,
"type": "float64"
}
],
"points": [
[
1704067200,
123.45,
123.45
]
]
},
"error": null
}{
"data": null,
"error": "unrecognized timeframe \"1y\": expected ytd|qtd|mtd|dtd|htd, <n>m|h|d|w, YYYY-MM-DD, YYYY-MM, YYYY, or RFC3339"
}{
"data": null,
"error": "this model requires authentication"
}{
"data": null,
"error": "this model requires the \"protocol-revenue-dataset\" permission; see https://app.blockworks.com/account/api for the public API permissions you hold"
}{
"data": null,
"error": "model \"project-revenue\" does not support granularity \"1h\" (supported: 1d)"
}Get Project timeseries
Daily gross, contra and net revenue in USD for one project. Each series is one project, keyed by its project slug, or its parent protocol’s short name when no project is mapped, and matching the protocol-revenue series key.
curl --request GET \
--url https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id} \
--header 'X-Blockworks-API-Key: <api-key>'import requests
url = "https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}"
headers = {"X-Blockworks-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Blockworks-API-Key': '<api-key>'}};
fetch('https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}', 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.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}",
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-Blockworks-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.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-Blockworks-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.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}")
.header("X-Blockworks-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blockworks.com/query/timeseries/project-revenue/{granularity}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-Blockworks-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"entity": {
"name": "<name>",
"slug": "<slug>"
},
"key": "<Project Revenue ID>",
"point_schema": [
{
"description": "Timestamp of the data point.",
"field": "time",
"name": "Time",
"time": true,
"type": "time"
},
{
"description": "Gross revenue in USD; negative on some days.",
"field": "grossRevenueUSD",
"name": "Gross Revenue (USD)",
"time": false,
"type": "float64"
},
{
"description": "Contra revenue in USD, deducted from gross revenue to give net revenue.",
"field": "contraRevenueUSD",
"name": "Contra Revenue (USD)",
"time": false,
"type": "float64"
}
],
"points": [
[
1704067200,
123.45,
123.45
]
]
},
"error": null
}{
"data": null,
"error": "unrecognized timeframe \"1y\": expected ytd|qtd|mtd|dtd|htd, <n>m|h|d|w, YYYY-MM-DD, YYYY-MM, YYYY, or RFC3339"
}{
"data": null,
"error": "this model requires authentication"
}{
"data": null,
"error": "this model requires the \"protocol-revenue-dataset\" permission; see https://app.blockworks.com/account/api for the public API permissions you hold"
}{
"data": null,
"error": "model \"project-revenue\" does not support granularity \"1h\" (supported: 1d)"
}Authorizations
API key sent in the X-Blockworks-API-Key header; x-messari-api-key is accepted for existing integrations. The catalog endpoints and models open to everyone need no key.
Path Parameters
Data granularity.
1d The Project Revenue ID identifying the series. A key no series has is not an error: the response carries an empty points array.
Query Parameters
Time window, one of: to-date (ytd, qtd, mtd, dtd, htd); relative, followed by m, h, d or w (30d, 12h, 4w; 1y and 1M are not accepted, use 365d, 52w, ytd or a calendar year); a calendar day (YYYY-MM-DD), month (YYYY-MM) or year (YYYY); or an RFC3339 instant, which runs from then to now. Mutually exclusive with start/end. Optional: with no window at all the query runs from the beginning of the data to now, which is only served where it fits the cap of 9000 points of the requested granularity, so a window is in practice required at fine granularities.
Window start, inclusive (RFC3339, unix seconds, or YYYY-MM-DD). Optional; defaults to the beginning of the data.
Window end, exclusive (RFC3339, unix seconds, or YYYY-MM-DD). Optional; defaults to now.
If true, return only the first and last point of the resolved time window instead of every point in it. A bounds request is exempt from the 9000-point maximum, since it returns at most two points per series however wide the window is.
Comma-separated metric fields to return; defaults to every metric. A point always leads with its timestamp, and the values that follow are described by point_schema in catalog order regardless of the order requested here.
grossRevenueUSD, contraRevenueUSD, netRevenueUSD Response format, overriding the Accept header: json (default), csv, or jsonl (NDJSON). csv and jsonl return the rows as a downloadable file.
json, csv, jsonl