BRK Server
A crate that serves Bitcoin data and swappable front-ends, built on top of brk_indexer, brk_computer and brk_interface.
The file handler, will serve the website specified by the user if any, which can be no website, default or custom (which is a blank folder for people to experiment). If a website is specified and the server is ran outside of the brk project and thus can't find the requested website, it will download the whole project with the correct version from Github and store it in .brk to be able to serve to website. This is due to the crate size limit on crates.io and the various shenanigans that need to be done to have a website in a crate.
The API uses brk_interface and so inherites all of its features including formats.
Endpoints
API
GET /api/vecs/index-count
Get the count of all existing indexes.
GET /api/vecs/id-count
Get the count of all existing vec ids.
GET /api/vecs/variant-count
Get the count of all existing vecs.
Equals to the sum of supported Indexes of each vec id.
GET /api/vecs/indexes
Get the list of all existing indexes.
GET /api/vecs/accepted-indexes
Get an object which has all existing indexes as keys and a list of their accepted variants as values.
GET /api/vecs/ids
Get a paginated list of all existing vec ids.
There are up to 1,000 values per page.
If the page param is omitted, it will default to page 0.
GET /api/vecs/variants
A list of all possible variants
GET /api/vecs/id-to-indexes
A list of all possible vec ids and their supported vec indexes
GET /api/vecs/index-to-ids
A list of all possible vec indexes and their supported vec ids
GET /api/vecs/{INDEX}-to-{ID}
This endpoint retrieves data based on the specified vector index and id.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
from |
signed int |
No | Inclusive starting index for pagination (default is 0). |
to |
signed int |
No | Exclusive ending index for pagination (default is the total number of results). Overrides count |
count |
unsigned int |
No | The number of values requested |
format |
string |
No | The format of the response. Options include json, csv, tsv, or md (default is json). |
Examples:
# GET /api/vecs/date-to-close
curl https://bitcoinresearchkit.org/api/vecs/date-to-close
# GET /api/vecs/date-to-close?from=-100
curl https://bitcoinresearchkit.org/api/vecs/date-to-close?from=-100
# GET /api/vecs/date-to-close?count=100&format=csv
curl https://bitcoinresearchkit.org/api/vecs/date-to-close?count=100&format=csv
GET /api/vecs/query
This endpoint retrieves data based on the specified vector index and ids.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
index |
VecIndex |
Yes | The vector index to query. |
ids |
VecId[] |
Yes | A comma or space-separated list of vector IDs to retrieve. |
from |
signed int |
No | Inclusive starting index for pagination (default is 0). |
to |
signed int |
No | Exclusive ending index for pagination (default is the total number of results). Overrides count |
count |
unsigned int |
No | The number of values requested |
format |
string |
No | The format of the response. Options include json, csv, tsv, or md (default is json). |
Examples:
# GET /api/vecs/query?index=date&ids=ohlc
curl https://bitcoinresearchkit.org/api/vecs/query?index=date&ids=ohlc
# GET /api/vecs/query?index=week&ids=ohlc,block-interval-average&from=0&to=20&format=md
curl https://bitcoinresearchkit.org/api/vecs/query?index=week&ids=ohlc,block-interval-average&from=0&to=20&format=md
Meta
GET /version
The version of the server and thus BRK.
Files
GET /*
Catch all.
When no pattern is found, the server will look for a match inside the folder of the chosen website, if any.