# @egodigital/appstore-connect

> API client for Apple App Store Connect API.

Latest version **0.5.0** (published 2020-07-20) · LGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @egodigital/appstore-connect
pnpm add @egodigital/appstore-connect
yarn add @egodigital/appstore-connect
bun add @egodigital/appstore-connect
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.5.0 |
| Published | 2020-07-20 |
| First published | 2019-11-26 |
| Weekly downloads | 0 |
| License | LGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 26 KB |
| Known vulnerabilities | 0 (+4 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 31 |
| Author | e.GO Digital GmbH, Aachen, Germany |
| Maintainers | ekegodigital, mkloubert, mkloubertego |
| Keywords | apple, app, store, connect, rest, api, client |

## Links

- npm: https://www.npmjs.com/package/@egodigital/appstore-connect
- Repository: https://github.com/egodigital/node-appstore-connect
- Homepage: https://github.com/egodigital/node-appstore-connect#readme
- Issues: https://github.com/egodigital/node-appstore-connect/issues
- npm.io page: https://npm.io/package/@egodigital/appstore-connect

## Dependencies (6)

- [got](https://npm.io/package/got.md) ^10.7.0
- [moment](https://npm.io/package/moment.md) ^2.27.0
- [csv-parser](https://npm.io/package/csv-parser.md) ^2.3.3
- [@types/node](https://npm.io/package/@types/node.md) ^10.17.27
- [jsonwebtoken](https://npm.io/package/jsonwebtoken.md) ^8.5.1
- [@types/jsonwebtoken](https://npm.io/package/@types/jsonwebtoken.md) ^8.5.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 0.5.0 (latest) — 2020-07-20
- 0.4.0 — 2020-02-24
- 0.3.1 — 2020-02-05
- 0.3.0 — 2020-01-22
- 0.2.0 — 2020-01-16
- 0.1.5 — 2019-11-28
- 0.1.4 — 2019-11-28
- 0.1.3 — 2019-11-27
- 0.1.2 — 2019-11-26
- 0.1.1 — 2019-11-26
- 0.1.0 — 2019-11-26

## README

[![npm](https://img.shields.io/npm/v/@egodigital/appstore-connect.svg)](https://www.npmjs.com/package/@egodigital/appstore-connect)

# @egodigital/appstore-connect

A simplfied library for [Node.js 10+](https://nodejs.org/docs/latest-v10.x/api/) for accessing [Apple's App Store Connect API](https://developer.apple.com/documentation/appstoreconnectapi), written in [TypeScript](https://www.typescriptlang.org/).

The module is quite new, so [issues](https://github.com/egodigital/node-appstore-connect/issues) and [pull requests](https://github.com/egodigital/node-appstore-connect/pulls) are very welcome :-)

## Install

Execute the following command from your project folder, where your `package.json` file is stored:

```bash
npm install --save @egodigital/appstore-connect
```

## Usage

```typescript
import * as fs from 'fs';
import { Client as AppStoreConnectClient, DownloadSalesReportFrequency } from '@egodigital/appstore-connect';

const PRIVATE_KEY = fs.readFileSync(
    '/path/to/your/p8/file'  // downloaded from https://appstoreconnect.apple.com/access/api
);

const CLIENT = new AppStoreConnectClient({
    apiKey: '<YOUR-API-KEY>',  // s. https://appstoreconnect.apple.com/access/api
    issuerId: '<YOUR-ISSUER-ID>',  // s. https://appstoreconnect.apple.com/access/api
    privateKey: PRIVATE_KEY,
});

const SUMMARY = await CLIENT.getAppDownloads({
    frequency: DownloadSalesReportFrequency.Weekly,
    vendorId: '<YOUR-VENDOR-ID>',  // s. https://appstoreconnect.apple.com/itc/payments_and_financial_reports
});

console.log(
    SUMMARY
);
```

## Documentation

The API documentation can be found [here](https://egodigital.github.io/appstore-connect/).

---
_Source: https://npm.io/package/@egodigital/appstore-connect · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._