# @itfin/rest

> ITFin REST API client for Browser and Node.js

Latest version **1.0.3** (published 2021-06-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install @itfin/rest
pnpm add @itfin/rest
yarn add @itfin/rest
bun add @itfin/rest
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2021-06-14 |
| First published | 2021-06-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 22.8 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Vitalii Savchuk |
| Maintainers | esvit |
| Keywords | itfin, itfin-api, api-client, api, rest |

## Links

- npm: https://www.npmjs.com/package/@itfin/rest
- npm.io page: https://npm.io/package/@itfin/rest

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [nanoid](https://npm.io/package/nanoid.md) ^3.1.23
- [axios-rate-limit](https://npm.io/package/axios-rate-limit.md) ^1.3.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

- 1.0.3 (latest) — 2021-06-14
- 1.0.2 — 2021-06-14
- 1.0.1 — 2021-06-14
- 1.0.0 — 2021-06-14

## README

# ITFin REST

> ITFin REST API client for Browser and Node.js

## Usage

<table>
<tbody valign=top align=left>
<tr><th>
Node
</th><td>

Install with `npm install @itfin/rest --save`

```js
const { Application } = require("@itfin/rest");
// or: import { Application } from '@itfin/rest';
```

</td></tr>
</tbody>
</table>

### Examples

More examples of usage you can find in `examples` folder.

#### Client Options

You can set the APIs' `baseUrl` and modify some behaviors (e.g. request timeout etc.) by passing a clientOptions object to the `Application` constructor.

```js
const secretKey = '...';
const secretToken = '...';
const clientOptions = {
  baseUrl: 'https://app.itfin.io',
  requestTimeout: 15000,
  requestsPerSecond: 2,
  debug: false
}

const app = new Application(secretKey, secretToken, clientOptions)
```

## LICENSE

[MIT](LICENSE)

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