# @netresearch/postdirekt-autocomplete-sdk

> SDK for the Deutsche Post Direkt Autocomplete API

Latest version **1.4.0** (published 2025-02-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @netresearch/postdirekt-autocomplete-sdk
pnpm add @netresearch/postdirekt-autocomplete-sdk
yarn add @netresearch/postdirekt-autocomplete-sdk
bun add @netresearch/postdirekt-autocomplete-sdk
```

## Health

**Score 50/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high maintenance score.

Warnings: low downloads.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.4.0 |
| Published | 2025-02-24 |
| First published | 2020-04-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10.0.0 |
| Dependencies | 0 |
| Unpacked size | 25.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Paul Siedler |
| Maintainers | cybot, powlomat, netresearch.admin, gitsko |

## Links

- npm: https://www.npmjs.com/package/@netresearch/postdirekt-autocomplete-sdk
- Repository: https://github.com/netresearch/postdirekt-autocomplete-monorepo
- npm.io page: https://npm.io/package/@netresearch/postdirekt-autocomplete-sdk

## Recent versions

- 1.4.0 (latest) — 2025-02-24
- 1.3.0 — 2024-02-05
- 1.2.2 — 2022-01-26
- 1.2.1 — 2021-12-01
- 1.2.0 — 2021-09-01
- 1.1.0 — 2020-05-26
- 1.0.1 — 2020-04-06
- 1.0.0 — 2020-04-04

## README

# Deutsche Post Direkt DATAFACTORY Autocomplete 2.0 API SDK

## Usage Example

### In browser
```javascript
import { SearchSubjects, createSearchService } from 'dist/lib/postdirekt-autocomplete';

let searchService = createSearchService('myApiAccessToken')
let requestBuilder = searchService.requestBuilder;
let request = requestBuilder.create({
  country: 'de',
  subject: Subject.Buildings,
  city: 'Test city',
  street: 'Test street'
});

let responsePromise = searchService.search(request);
responsePromise.then(response => { /* handle response */ })
```

### In node

Running in node currently is only possible with a `fetch` polyfill
 (e.g. [isomorphic-fetch](https://www.npmjs.com/package/isomorphic-fetch)).
 A native implementation might follow in the future.

```javascript
require('es6-promise').polyfill();
require('isomorphic-fetch');
const sdk = require('./dist/browser/postdirekt-autocomplete.umd');
let process = require('process');

const token = process.env.TOKEN;

const searchService = sdk.createSearchService(token);

const request = searchService.requestBuilder.create({
  country: 'de',
  street: 'Be',
  city: 'Leipzig',
  subject: sdk.SearchSubjects.PostalCodesCitiesStreets,


});

searchService.search(request).then(
  (response) => {
    console.table(response.addresses)
  }
).catch(
  console.error
);

```

---
_Source: https://npm.io/package/@netresearch/postdirekt-autocomplete-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._