Skip to content

andipaetzold/zwift-data

Repository files navigation

npm tests downloads license semantic-release

Zwift Data

The zwift-data npm package provides data about Zwift:

  • Achievements
  • Bike Frames
  • Bike Front Wheels
  • Bike Rear Wheels
  • Bike Shoes
  • Challenges
  • Glasses
  • Headgear
  • Jerseys
  • Paint Job
  • Routes
  • Run Shirts
  • Run Shoes
  • Run Shorts
  • Segments
  • Socks
  • Training Plans
  • Notable Moment Types
  • Unlockable Categories
  • Worlds

Installation

npm install zwift-data

or

yarn add zwift-data

Usage

import {
  achievements,
  bikeFrames,
  bikeFrontWheels,
  bikeRearWheels,
  bikeShoes,
  challenges,
  glasses,
  headgears,
  jerseys,
  notableMomentTypes
  paintJobs
  routes
  runShirts,
  runShoes,
  runShorts,
  segments,
  socks,
  trainingPlans,
  unlockableCategories,
  worlds,
 } from "zwift-data";

The package also exports TypeScript types.

The data structure is documented here.

Data source

Some data is automatically fetched and updated from Zwift's public API.

Data was also manually collected from

License

MIT