cepik-api-client

A modern TypeScript/JavaScript library for retrieving data from the public API of the Polish National Vehicles Database (CEPIK).

📦 Installation

npm install cepik-client

yarn add cepik-client

pnpm add cepik-client

🚀 Quick Start

import { CEPIKClient } from "cepik-client";

🛠️ Development

To run the full quality suite locally:

npm install
npm run build       # compile TypeScript to dist/
npm run lint        # static analysis
npm run test        # run unit tests
npm run coverage    # generate coverage report

The package also includes a prepare script so that if you install directly directly from the Git repository (e.g. npm install cepik-client), it will compile automatically.

🤝 Contributing

Please open issues for bugs or feature requests and send pull requests with clear descriptions. The library follows semantic versioning; bump the version in package.json and update the changelog when adding features or fixes.

📝 Types and Enums

Enums

import {
} from "cepik-client";

Types

import type {
} from "cepik-client";

🧪 Testing

npm run test

🔍 Linting

npm run lint

🏗️ Building

npm run build

The compiled code is located in the dist/ directory.

📚 Resources

• Official CEPIK API
• CEPIK API Documentation - Details about endpoints, formats and limitations.
• Dictionaries - all enums used in the project.

📄 License

MIT © 2026 miqel-dll

🤝 Support

If you encounter a problem or have a suggestion, please open an issue on GitHub.

Author: miqel-dll Version: 0.0.7