https://github.com/nexveridian/ark-invest-api-rust
A REST API for ARK Invest holdings data, written in rust using axum, Redoc/Swagger through Aide, and parquet using polars. Not affiliated with Ark Invest
https://github.com/nexveridian/ark-invest-api-rust
aide api-rest ark ark-funds ark-invest arkfunds arkinvest axum etf finance polars rust stock
Last synced: about 1 year ago
JSON representation
A REST API for ARK Invest holdings data, written in rust using axum, Redoc/Swagger through Aide, and parquet using polars. Not affiliated with Ark Invest
- Host: GitHub
- URL: https://github.com/nexveridian/ark-invest-api-rust
- Owner: NexVeridian
- License: apache-2.0
- Created: 2023-03-14T23:36:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-28T22:56:20.000Z (about 1 year ago)
- Last Synced: 2025-03-28T23:29:35.595Z (about 1 year ago)
- Topics: aide, api-rest, ark, ark-funds, ark-invest, arkfunds, arkinvest, axum, etf, finance, polars, rust, stock
- Language: Rust
- Homepage: https://api.NexVeridian.com
- Size: 87.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-Apache
Awesome Lists containing this project
README
A REST API for ARK Invest holdings data, written in rust using [axum](https://github.com/tokio-rs/axum), Redoc/Swagger through [Aide](https://github.com/tamasfe/aide), and parquet using [polars](https://github.com/pola-rs/polars)
The REST API is hosted at [api.NexVeridian.com](https://api.NexVeridian.com)
The code for the data generator is [github.com/NexVeridian/ark-invest-api-rust-data](https://github.com/NexVeridian/ark-invest-api-rust-data)
Not affiliated with Ark Invest
# Install
Copy docker-compose.yml
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](https://api.NexVeridian.com) or [ark-invest-api-rust-data](https://github.com/NexVeridian/ark-invest-api-rust-data)
```
├───data
│ └───parquet
│ └───*.parquet
├───docker-compose.yml
```
`docker compose up --pull always`
If not using nginx, set environment NGINX = false in docker compose
# Dev Install
## Dev Containers
Install docker, vscode and the [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
`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](https://api.NexVeridian.com) or [ark-invest-api-rust-data](https://github.com/NexVeridian/ark-invest-api-rust)
`cargo run`
## Docker Compose
`git clone`
Place data in `data\parquet\*.parquet` with the ticker in all caps `ARKK.parquet`, get the data from [api.NexVeridian.com](https://api.NexVeridian.com) or [ark-invest-api-rust-data](https://github.com/NexVeridian/ark-invest-api-rust)
`docker compose build && docker compose up`
Remove the cargo cache for buildkit with `docker builder prune --filter type=exec.cachemount`
# License
All code in this repository is dual-licensed under either [License-MIT](./LICENSE-MIT) or [LICENSE-APACHE](./LICENSE-Apache) at your option. This means you can select the license you prefer.
[Why dual license](https://github.com/bevyengine/bevy/issues/2373)