Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pinax-network/substreams-atomic-api
Atomicmarket sales on Antelope chains
https://github.com/pinax-network/substreams-atomic-api
api atomicassets atomicmarket blockchain bun clickhouse rest
Last synced: about 2 months ago
JSON representation
Atomicmarket sales on Antelope chains
- Host: GitHub
- URL: https://github.com/pinax-network/substreams-atomic-api
- Owner: pinax-network
- License: mit
- Created: 2023-10-13T09:07:41.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2023-11-23T15:57:58.000Z (about 1 year ago)
- Last Synced: 2024-04-01T16:23:37.075Z (9 months ago)
- Topics: api, atomicassets, atomicmarket, blockchain, bun, clickhouse, rest
- Language: TypeScript
- Homepage:
- Size: 86.9 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [`Substreams`](https://substreams.streamingfast.io/) Atomic API
[](https://github.com/pinax-network/substreams-atomic-api/actions/workflows/bun-test.yml)
## REST API
|
Pathname| Description |
|----------------------------------------|-----------------------|
| GET `/health` | Health check
| GET `/chains` | Get available chains
| GET `/sales` | Get sales by `chain`, `collection_name`, `sale_id`, `timestamp`, `block_number`, `template_id`, `listing_price_amount`, `listing_price_symcode`, `trx_id` or `contains_asset_id`
| GET `/sales/aggregate` | Get aggregate of sales for given time range filtered by `chain`,`collection_name` or `listing_price_symcode`
| GET `/metrics` | Prometheus metrics
| GET `/openapi` | [OpenAPI v3 JSON](https://spec.openapis.org/oas/v3.0.0)
Supported aggregate functions : `count`, `sum`, `min`, `max`, `avg`, `median`
Supported aggregate columns: `sale_id`, `total_asset_ids`, `listing_price_amount`
## Requirements
- [Clickhouse](https://clickhouse.com/)
Additionnaly to pull data directly from a substream:
- [Substreams Sink Clickhouse](https://github.com/pinax-network/substreams-sink-clickhouse/)
## Quickstart
```console
$ bun install
$ bun dev
```
## [`Bun` Binary Releases](https://github.com/pinax-network/substreams-sink-websockets/releases)
> Linux Only
```console
$ wget https://github.com/pinax-network/substreams-atomic-api/releases/download/v0.2.0/substreams-atomic-api
$ chmod +x ./substreams-atomic-api
```
## `.env` Environment variables
```env
# API Server
PORT=8080
HOSTNAME=localhost
# Clickhouse Database
HOST=http://127.0.0.1:8123
DATABASE=default
USERNAME=default
PASSWORD=
MAX_LIMIT=500
# Logging
VERBOSE=true
```
## Required database structure
`substreams-sink-clickhouse` auto generates some tables (see [Database structure](https://github.com/pinax-network/substreams-sink-clickhouse#database-structure) section).
For this API to work, you will also need to provide following schemas to `substreams-sink-clickhouse` (see [Schema initialization](https://github.com/pinax-network/substreams-sink-clickhouse#schema-initialization) section):
- `substreams-atomicmarket-sales` [schema](https://github.com/pinax-network/substreams-atomicmarket-sales/blob/master/schema.sql)
- `substreams-atomicassets` [schema](https://github.com/pinax-network/substreams-atomicassets/blob/master/schema.sql)
The minimum required added tables to the database structure are:
```mermaid
erDiagram
Sales }|--|{ Assets : " "
Sales {
sale_id UInt64
trx_id String
seller String
asset_ids Array(UInt64)
offer_id Int64
listing_price_amount Int64
listing_price_precision UInt8
listing_price_symcode String
settlement_symbol_precision UInt8
settlement_symbol_code String
maker_marketplace String
collection_name String
collection_fee Float64
}
Assets {
asset_id UInt64
scope String
collection_name String
template_id Int32
}
```
## Help
```console
$ ./substreams-atomic-api -h
Usage: substreams-atomic-api [options]
Atomic API
Options:
-V, --version output the version number
-p, --port HTTP port on which to attach the API (default: "8080", env: PORT)
-v, --verbose Enable verbose logging (choices: "true", "false", default: false, env: VERBOSE)
--hostname Server listen on HTTP hostname (default: "localhost", env: HOSTNAME)
--host Database HTTP hostname (default: "http://localhost:8123", env: HOST)
--username Database user (default: "default", env: USERNAME)
--password Password associated with the specified username (default: "", env: PASSWORD)
--database The database to use inside ClickHouse (default: "default", env: DATABASE)
--max-limit Maximum LIMIT queries (default: 10000, env: MAX_LIMIT)
-h, --help display help for command
```
## Docker environment
Pull from GitHub Container registry
```bash
docker pull ghcr.io/pinax-network/substreams-atomic-api:latest
```
Build from source
```bash
docker build -t substreams-atomic-api .
```
Run with `.env` file
```bash
docker run -it --rm --env-file .env ghcr.io/pinax-network/substreams-atomic-api
```