ark-invest-api-rust/README.md

A REST API for ARK Invest holdings data, written in rust using axum, Redoc/Swagger through Aide, and parquet using polars

api.NexVeridian.com

Not affiliated with Ark Invest

Install

Create docker-compose.yml

version: "3"
services:
    ark-invest-api-rust:
        image: ghcr.io/nexveridian/ark-invest-api-rust:latest
        container_name: ark-invest-api-rust
        restart: unless-stopped
        volumes:
            - ./data:/ark-invest-api-rust/data
        ports:
            - "3000:3000"

volumes:
    data:

Recomended: add nginx-certbot to the docker-compose file, GitHub, Docker Hub

Create data folder next to docker-compose.yml, data\parquet\*.parquet with the ticker in all caps ARKK.parquet, get the data from api.NexVeridian.com or ark-invest-api-rust-data

├───data
│   └───parquet
│   	└───*.parquet
├───docker-compose.yml

docker compose up --pull always

Dev Install

Dev Containers

Install docker, vscode and the Dev Containers Extension

git clone

Ctrl+Shift+P Dev Containers: Open Folder in Container

Place data in data\parquet\*.parquet with the ticker in all caps ARKK.parquet, get the data from api.NexVeridian.com or ark-invest-api-rust-data

cargo run

Docker Compose

git clone

Recomended: add nginx-certbot to the docker-compose file, GitHub, Docker Hub

Place data in data\parquet\*.parquet with the ticker in all caps ARKK.parquet, get the data from api.NexVeridian.com or ark-invest-api-rust-data

docker compose build && docker compose up

Remove the cargo cache for buildkit with docker builder prune --filter type=exec.cachemount