# Hey API

Code generator that turns OpenAPI specifications into TypeScript clients, schemas and other generated code, published as @hey-api/openapi-ts.


Source: https://findsoftware.frbit.cloud/hey-api/
Last reviewed: 2026-11-09
Listed since: 2026-11-09

## Record

### Links

- home: https://heyapi.dev
- repository: https://github.com/hey-api/hey-api
- docs: https://heyapi.dev/docs/openapi/typescript/get-started
- x: https://x.com/mrlubos
- bluesky: https://bsky.app/profile/heyapi.dev
- forum: https://github.com/orgs/hey-api/discussions

### Identity

- status: active
- maintainer: Hey API
- maintainerType: unknown
- parent: unknown
- firstRelease: 2024
- hqCountry: unknown

### Kind

- category: dev-tool
- hosting: not applicable
- language: javascript
- runtime: node
- runtimeMin: node 22
- basedOn: unknown

### Content

- contentStore: not applicable
- databases: not applicable
- adminUi: not applicable
- headlessApi: not applicable
- templating: not applicable
- i18n: not applicable

### Rendering and deploy

- runsAs: unknown
- renderingModes: not applicable
- installMethod: npm

### License

- licenseModel: open-source
- license: MIT

### Releases

- currentMajor: 0
- latestReleaseDate: 2026-06-22

### Adoption

- githubStargazers: 5563
- packagistDownloads: not applicable
- npmWeeklyDownloads: 7134416
- contributors: 183
- pluginCount: unknown
- packagistMonthlyDownloads: unknown
- ecosystemsMonthlyDownloads: unknown
- httpArchiveSites: unknown
- wordpressActiveInstalls: unknown
- dependentRepos: unknown
- dependentPackages: unknown

### Sources

- urls: https://heyapi.dev/ (read 2026-11-09)
- urls: https://heyapi.dev/docs/openapi/typescript/get-started (read 2026-11-09)
- urls: https://api.github.com/repos/hey-api/hey-api (read 2026-11-09)
- firstRelease: https://registry.npmjs.org/@hey-api%2fopenapi-ts (read 2026-11-09)
- maintainer: https://raw.githubusercontent.com/hey-api/hey-api/main/LICENSE (read 2026-11-09)
- language: https://api.github.com/repos/hey-api/hey-api (read 2026-11-09)
- category: https://heyapi.dev/docs/openapi/typescript/get-started (read 2026-11-09)
- runtime: https://heyapi.dev/docs/openapi/typescript/get-started (read 2026-11-09)
- runtimeMin: https://heyapi.dev/docs/openapi/typescript/get-started (read 2026-11-09)
- installMethod: https://heyapi.dev/docs/openapi/typescript/get-started (read 2026-11-09)
- license: https://raw.githubusercontent.com/hey-api/hey-api/main/LICENSE (read 2026-11-09)
- licenseModel: https://raw.githubusercontent.com/hey-api/hey-api/main/LICENSE (read 2026-11-09)
- currentMajor: https://registry.npmjs.org/@hey-api%2fopenapi-ts (read 2026-11-09)
- latestReleaseDate: https://registry.npmjs.org/@hey-api%2fopenapi-ts (read 2026-11-09)
- githubStargazers: https://api.github.com/repos/hey-api/hey-api (read 2026-11-09)
- contributors: https://api.github.com/repos/hey-api/hey-api/contributors?per_page=1 (read 2026-11-09)
- npmWeeklyDownloads: https://api.npmjs.org/downloads/range/2026-11-01:2026-11-07/@hey-api/openapi-ts (read 2026-11-09)

## Notes

Hey API is an OpenAPI code generator for TypeScript, published on npm as @hey-api/openapi-ts. It runs from the command line, from a package.json script or from a script that calls its createClient function, reads an OpenAPI specification and writes the generated client code into an output directory of the project. The generated clients target HTTP clients such as the Fetch API, Angular, Axios, Next.js and Nuxt, and the package accepts any OpenAPI specification.

The package is installed as a development dependency, and the build pipeline can run it through the Vite plugin the project publishes alongside it. The repository is a monorepo that holds other packages of the Hey API ecosystem.

The project is maintained by Hey API, and the license file names it as the copyright holder under the MIT license.

## Worth knowing

The package states that it is in initial development and asks users to pin an exact version, and the project publishes migration notes for each breaking release. The project also operates a hosted Hey API Registry, at app.heyapi.dev, that stores specifications; the generator can read a specification from it by a registry name.

---

Data licensed CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/). Attributes are recorded, never scored; absent means unknown.
Credit, in full: FindSoftware, CC BY 4.0