NexVeridian/ark-invest-api-rust
1
0
Fork 0
mirror of https://github.com/NexVeridian/ark-invest-api-rust.git synced 2025-09-02 01:49:11 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

1.0.0

Browse source
This commit is contained in:
Elijah McMorris 2023-03-14 23:40:18 +00:00 • committed by NexVeridian@gmail.com
commit 3a34f6c1a3
12 changed files with 705 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

17
.devcontainer/Dockerfile Normal file
View file

@ -0,0 +1,17 @@
FROM mcr.microsoft.com/devcontainers/rust:bullseye
RUN rustup target add x86_64-unknown-linux-musl && \
apt-get update && \
apt install -y build-essential xz-utils musl-tools musl-dev gcc-multilib && \
rustup update
RUN LAZYGIT_VERSION=$(curl -s "https://api.github.com/repos/jesseduffield/lazygit/releases/latest" | grep -Po '"tag_name": "v\K[0-9.]+') && \
curl -Lo lazygit.tar.gz "https://github.com/jesseduffield/lazygit/releases/latest/download/lazygit_${LAZYGIT_VERSION}_Linux_x86_64.tar.gz" && \
sudo tar xf lazygit.tar.gz -C /usr/local/bin lazygit && \
rm -rf lazygit.tar.gz
RUN BTOP_VERSION=$(curl -s "https://api.github.com/repos/aristocratos/btop/releases/latest" | grep -Po '"tag_name": "v\K[0-9.]+') && \
wget "https://github.com/aristocratos/btop/releases/download/${BTOP_VERSION}/btop-x86_64-linux-musl.tbz" && \
sudo tar -xvf btop-x86_64-linux-musl.tbz && \
cd btop && ./install.sh && cd .. && \
rm -rf btop-x86_64-linux-musl.tbz btop

65
.devcontainer/devcontainer.json Normal file
View file

@ -0,0 +1,65 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/rust
// https://containers.dev/implementors/json_reference/#variables-in-devcontainerjson
{
"name": "Rust",
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
// "image": "mcr.microsoft.com/devcontainers/rust:0-1-bullseye",
"build": {
// Path is relataive to the devcontainer.json file.
"dockerfile": "Dockerfile"
},
// https://github.com/microsoft/vscode-remote-release/issues/2485#issuecomment-1156342780
"runArgs": [
"--name",
"devcontainer-${containerWorkspaceFolderBasename}"
],
"initializeCommand": "docker rm -f devcontainer-${containerWorkspaceFolderBasename} || true",
// Use 'mounts' to make the cargo cache persistent in a Docker Volume.
"mounts": [
{
// "source": "devcontainer-cargo-cache-${devcontainerId}",
"source": "devcontainer-cargo-cache-${containerWorkspaceFolderBasename}",
"target": "/usr/local/cargo",
"type": "volume"
}
],
// Features to add to the dev container. More info: https://containers.dev/features.
"features": {
"ghcr.io/devcontainers/features/git:1": {}
// "ghcr.io/devcontainers/features/nix:1": {
// "packages": [
// "btop"
// // "lazygit"
// ]
// }
},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": {
// },
"postAttachCommand": {
"AddGitSafeDir": "git config --global --add safe.directory /workspaces/${containerWorkspaceFolderBasename}"
},
// Configure tool-specific properties.
// "customizations": {},
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
"remoteUser": "root",
"customizations": {
"vscode": {
"extensions": [
"vadimcn.vscode-lldb",
"serayuzgur.crates",
"bungcip.better-toml",
"rust-lang.rust-analyzer",
"mutantdino.resourcemonitor",
"christian-kohler.path-intellisense",
"Swellaby.vscode-rust-test-adapter",
"Gruntfuggly.todo-tree",
"ms-azuretools.vscode-docker",
"redhat.vscode-yaml"
]
}
}
}

7
.dockerignore Normal file
View file

@ -0,0 +1,7 @@
.dockerignore
/.devcontainer
/target
Cargo.lock
docker-compose.yml
Dockerfile
README.md

111
.gitignore vendored Normal file
View file

@ -0,0 +1,111 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST
.vscode
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
db.sqlite3
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
target/
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# SageMath parsed files
*.sage.py
# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/
# Spyder project settings
.spyderproject
.spyproject
# Rope project settings
.ropeproject
# mkdocs documentation
/site
# mypy
.mypy_cache/
/target
Cargo.lock
data/csv/*
data/parquet/*

24
Cargo.toml Normal file
View file

@ -0,0 +1,24 @@
[package]
name = "ark-invest-api-rust"
version = "0.1.0"
edition = "2021"
[dependencies]
polars = { version = "0.28", features = [
"lazy",
"strings",
"parquet",
"round_series",
"serde",
"json",
] }
axum = "0.6"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
tokio = { version = "1.26", features = ["full"] }
aide = { version = "0.10", features = ["redoc", "axum"] }
schemars = { version = "0.8", features = ["chrono"] }
chrono = { version = "0.4", features = ["serde"] }
glob = { version = "0.3" }
strum_macros = "0.24"
tower = { version = "0.4.12", features = ["limit", "buffer"] }

23
Dockerfile Normal file
View file

@ -0,0 +1,23 @@
FROM rust:latest AS builder
RUN rustup target add x86_64-unknown-linux-musl && apt update && apt install -y musl-tools musl-dev
WORKDIR /ark-invest-api-rust
COPY . .
RUN --mount=type=cache,target=/usr/local/cargo,from=rust,source=/usr/local/cargo \
--mount=type=cache,target=./target \
cargo build --target x86_64-unknown-linux-musl --release && \
cp ./target/x86_64-unknown-linux-musl/release/ark-invest-api-rust .
FROM alpine:latest
WORKDIR /ark-invest-api-rust
COPY --from=builder ark-invest-api-rust/ark-invest-api-rust .
ENV PORT=3000
EXPOSE 3000
CMD ["./ark-invest-api-rust"]

192
LICENSE Normal file
View file

@ -0,0 +1,192 @@
Copyright 2023, Elijah McMorris ( NexVeridian )
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
Copyright 2023, Elijah McMorris ( NexVeridian )
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

59
README.md Normal file
View file

@ -0,0 +1,59 @@
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)
[api.NexVeridian.com](https://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](https://github.com/JonasAlfredsson/docker-nginx-certbot#run-with-docker-compose), [Docker Hub](https://hub.docker.com/r/jonasal/nginx-certbot)
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`
# 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`
Recomended: add nginx-certbot to the docker-compose file, [GitHub](https://github.com/JonasAlfredsson/docker-nginx-certbot#run-with-docker-compose), [Docker Hub](https://hub.docker.com/r/jonasal/nginx-certbot)
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`

18
docker-compose.yml Normal file
View file

@ -0,0 +1,18 @@
version: "3"
services:
ark-invest-api-rust:
# image: ghcr.io/NexVeridian/ark-invest-api-rust:latest
image: ark-invest-api-rust
build:
context: .
args:
DOCKER_BUILDKIT: 1
container_name: ark-invest-api-rust
restart: unless-stopped
volumes:
- ./data:/ark-invest-api-rust/data
ports:
- "3000:3000"
volumes:
data:

89
src/main.rs Normal file
View file

@ -0,0 +1,89 @@
use aide::{
axum::{
routing::{get, get_with},
ApiRouter, IntoApiResponse,
},
openapi::{Info, OpenApi},
redoc::Redoc,
transform::TransformOperation,
};
use axum::{error_handling::HandleErrorLayer, http::StatusCode, BoxError, Extension, Json};
use std::{net::SocketAddr, time::Duration};
use tower::{buffer::BufferLayer, limit::RateLimitLayer, ServiceBuilder};
mod routes;
async fn serve_api(Extension(api): Extension<OpenApi>) -> impl IntoApiResponse {
return Json(api);
}
fn description_date<'t>(op: TransformOperation<'t>) -> TransformOperation<'t> {
op.parameter_untyped("start", |p| {
p.description("Start date range - Inclusive >= - ISO 8601")
})
.parameter_untyped("end", |p| {
p.description("End date range - Inclusive <= - ISO 8601")
})
}
#[tokio::main]
async fn main() {
let rate_limit = |req_per_sec: u64| {
ServiceBuilder::new()
.layer(HandleErrorLayer::new(|err: BoxError| async move {
(
StatusCode::INTERNAL_SERVER_ERROR,
format!("Unhandled error: {}", err),
)
}))
.layer(BufferLayer::new(1024))
.layer(RateLimitLayer::new(req_per_sec, Duration::from_secs(1)))
};
let app = ApiRouter::new()
.route("/", Redoc::new("/api.json").axum_route())
.api_route(
"/arkvc_holdings",
get_with(routes::arkvc_holdings, |mut o| {
o = o.id("ARKVC Holdings");
description_date(o)
}),
)
.layer(rate_limit(5))
.api_route(
"/ark_holdings",
get_with(routes::ark_holdings, |mut o| {
o = o.id("ARK* ETF Holdings");
description_date(o)
}),
)
.layer(rate_limit(20))
.route("/api.json", get(serve_api));
let mut api = OpenApi {
info: Info {
summary: Some(
"A REST API for ARK Invest holdings data, writen 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)\n\nNot affiliated with Ark Invest
".to_owned(),
),
description: Some(
"[Github](https://github.com/NexVeridian/ark-invest-api-rust)\n\n[Contact Info](https://NexVeridian.com/About)".to_owned(),
),
..Info::default()
},
..OpenApi::default()
};
let addr = SocketAddr::from(([0, 0, 0, 0], 3000));
println!("listening on {}", addr);
axum::Server::bind(&addr)
.serve(
app.finish_api(&mut api)
.layer(Extension(api))
.into_make_service(),
)
.await
.unwrap();
}

29
src/routes.rs Normal file
View file

@ -0,0 +1,29 @@
use aide::axum::IntoApiResponse;
use axum::extract::Query;
mod polars_utils;
pub async fn arkvc_holdings(date_range: Query<polars_utils::DateRange>) -> impl IntoApiResponse {
let df = polars_utils::get_parquet("ARKVC".to_owned()).await.unwrap();
let filter_df = polars_utils::filter_date_range(df, date_range)
.await
.unwrap();
return axum::Json(polars_utils::to_json(filter_df).await.unwrap());
}
pub async fn ark_holdings(
ticker: Query<polars_utils::Ticker>,
date_range: Query<polars_utils::DateRange>,
) -> impl IntoApiResponse {
let df = polars_utils::get_parquet(ticker.ticker.to_string())
.await
.unwrap();
let filter_df = polars_utils::filter_date_range(df, date_range)
.await
.unwrap();
return axum::Json(polars_utils::to_json(filter_df).await.unwrap());
}

71
src/routes/polars_utils.rs Normal file
View file

@ -0,0 +1,71 @@
use axum::extract::Query;
use chrono::NaiveDate;
use polars::prelude::*;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::error::Error;
use std::fs::File;
pub async fn get_parquet(file: String) -> Result<DataFrame, Box<dyn Error>> {
let mut file = File::open(format!("data/parquet/{}.parquet", file))?;
let df = ParquetReader::new(&mut file).finish()?;
Ok(df)
}
pub async fn to_json(mut df: DataFrame) -> Result<Value, Box<dyn Error>> {
let mut buffer = Vec::new();
JsonWriter::new(&mut buffer)
.with_json_format(JsonFormat::Json)
.finish(&mut df)?;
let json_string = String::from_utf8(buffer)?;
let json: Value = serde_json::from_str(&json_string)?;
Ok(json)
}
#[derive(Serialize, Deserialize, JsonSchema)]
pub struct DateRange {
start: Option<NaiveDate>,
end: Option<NaiveDate>,
}
pub async fn filter_date_range(
df: DataFrame,
date_range: Query<DateRange>,
) -> Result<DataFrame, Box<dyn Error>> {
if date_range.start.or(date_range.end) == None {
return Ok(df);
}
let mask = df["date"]
.date()?
.as_date_iter()
.map(|x| {
let date = x.unwrap();
match (date_range.start, date_range.end) {
(Some(start), Some(end)) => return date >= start && date <= end,
(Some(start), _) => return date >= start,
(_, Some(end)) => return date <= end,
_ => return false,
}
})
.collect();
let filter_df = df.filter(&mask)?;
Ok(filter_df)
}
#[derive(Serialize, Deserialize, JsonSchema, strum_macros::Display)]
pub enum TypeTicker {
ARKF,
ARKG,
ARKK,
ARKQ,
ARKW,
ARKX,
}
#[derive(Serialize, Deserialize, JsonSchema)]
pub struct Ticker {
pub ticker: TypeTicker,
}