Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

732 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TechAPI

TechAPI

Curated, open dataset for consumer electronics specs.
Free, share-alike, machine-readable.

validate-data  Data: CC-BY-SA 4.0

This repo holds the curated dataset and the public site (Astro intro + playground). The API server, ingestion crawlers, coverage checks, and the static-dump generator live in TechEngine.

Layout

data/brand/<country>/<slug>.json                       # e.g. data/brand/kr/samsung.json
data/soc/<manufacturer>/<year>/<slug>.json             # data/soc/qualcomm/2024/snapdragon-8-elite.json
data/smartphone/<brand>/<year>/<slug>.json             # data/smartphone/samsung/2025/galaxy-s25.json
data/gpu/<manufacturer>/<year>/<segment>/<slug>.json   # data/gpu/nvidia/2025/consumer/geforce-rtx-5090.json
data/cpu/<manufacturer>/<year>/<segment>/<slug>.json   # data/cpu/intel/2023/consumer/core-i9-14900k.json

All paths use singular folder names. Slugs are kebab-case and unique within each category.

The Astro site lives under site/ and is the deploy target for GitHub Pages. It consumes the static JSON dump produced by TechEngine's weekly-refresh workflow.

Self-Check

A lightweight bundled validator lives at app/validate.py. It runs on every PR via validate-data.yml and is also chained into the heavier TechEngine validation workflow as a downstream job.

python -m app.validate

The validator uses only the Python standard library; no install step required.

Branching

This repo follows git-flow:

Branch Role
main Released state. Publishing the site and notifying TechEngine both fire on a push here, so it only moves through a release PR.
develop Integration. Every data, feature and fix branch targets this.
feat/*, data/*, fix/*, chore/* Short-lived work branches, cut from develop.

A release is a PR from develop to main; merging it deploys the site and tells TechEngine to pick up the new data. Automation follows the same rule — the submodule bump and the verified-promotion bot both land on develop.

Contributing

Open a PR against develop with the new/updated JSON file. The PR template walks through what to include. The validator must pass. All records (brand, soc, smartphone, gpu, and cpu) must include source_urls with at least one canonical reference (vendor product page, Wikipedia infobox, datasheet).

License

Data is licensed CC-BY-SA 4.0; attribute "Data from TechAPI" and share alike. The bundled validator code is MIT.

About

Open data for every device. Free RESTful API for smartphone, SoC, and GPU specs.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors