# @acryl/data-service-client-js

> ## Usage

Latest version **4.0.3** (published 2020-04-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @acryl/data-service-client-js
pnpm add @acryl/data-service-client-js
yarn add @acryl/data-service-client-js
bun add @acryl/data-service-client-js
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.0.3 |
| Published | 2020-04-03 |
| First published | 2019-09-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 131.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | deadblackclover, eaz |

## Links

- npm: https://www.npmjs.com/package/@acryl/data-service-client-js
- npm.io page: https://npm.io/package/@acryl/data-service-client-js

## Dependencies (2)

- [@acryl/bignumber](https://npm.io/package/@acryl/bignumber.md) ^0.0.3
- [@acryl/data-entities](https://npm.io/package/@acryl/data-entities.md) ^2.0.0

## Recent versions

- 4.0.3 (latest) — 2020-04-03
- 4.0.2 — 2019-09-04

## README

# JS Library for Acryl data services

## Usage

```typescript
const DataServiceClient = require('@acryl/data-service-client-js').default;

// Initialization
const client = new DataServiceClient({
  rootUrl: 'http://api.acrylplatform.com/v0',
  fetch: req => window.fetch(req).then(res => res.text()), // fetch must return string
  parse: str => JSON.parse(str),
});

// Fetching
(async () => {
  const { data } = await client.getAssets('ACRYL'); // data: Asset {}
})();
```

## Methods

### Response format

`{ data, ...meta }`

### All methods do GET requests, until query is under 2k symbols, then automatically switch to POST

- getAssets:

```typescript
await client.getAssets('ACRYL'); // One { data: Asset }
await client.getAssets('ACRYL', '68X83bfvSSQauL81fcfqA3Vne9s4y2BRAG36DGRcv4V2'); // Or many { data: Asset[] }
await client.getAssetsByTicker('ACRYL');  // Many { data: Asset[] }
await client.getAssetsByTicker('*');  // Many { data: Asset[] } - all assets
```

- getPairs

```typescript
const getPairs = client.getPairs('MATCHER_ID'); // set up DEX matcher
await getPairs([
  'ACRYL/68X83bfvSSQauL81fcfqA3Vne9s4y2BRAG36DGRcv4V2',
  'ACRYL/4vN61TPpk5qKidGt5RYgd1To4nzxsoDyAL5buBk37hwF'
]); // get pairs
```

- getExchangeTxs:

```typescript
await client.getExchangeTxs('8rEwYY4wQ4bkEkk95EiyeQnvnonX6TAnU6eiBAbVSADk'); // By id { data: Tx }
await client.getExchangeTxs({
  timeStart?: string | Date | number;
  timeEnd?: string | Date | number;
  matcher?: string;
  sender?: string;
  amountAsset?: string | Asset;
  priceAsset?: string | Asset;
  limit?: number;
  sort?: 'asc'|'desc';
}); // With filters { data: Tx[] }
await client.getExchangeTxs(); // Top 100 with default filters (timeStart = timestamp of first entry in db, timeEnd = now)
```

- aliases:

```typescript
const alias1 = await client.aliases.getById('@askerych');
/*
  { data: {
      address: '3P5uMgn1xvrm7g3sbUVAGLtetkNUa1AHn2M',
      alias: '@askerych'
    }
  }
  */
const alias2 = await client.aliases.getByAddress(
  '3P5uMgn1xvrm7g3sbUVAGLtetkNUa1AHn2M'
);
/*
  { data: [{
      address: '3P5uMgn1xvrm7g3sbUVAGLtetkNUa1AHn2M',
      alias: '@askerych'
    }]
  }
  */
```

- getCandles:

```typescript
await client.getCandles(amountAsset: string, priceAsset: string, {
  timeStart: string | Date | number;
  timeEnd?: string | Date | number;
  interval: string; // interval pattern is xy, where x - number, y - one of m (minutes), h (hours), d (days), M (Month)
});
await client.getCandles('ACRYL', '68X83bfvSSQauL81fcfqA3Vne9s4y2BRAG36DGRcv4V2', {
  timeStart: '2018-12-01',
  timeEnd: '2018-12-31',
  interval: '1d'
});
```

## Pagination

```typescript
type Response<T> = {
  data: T;
  fetchMore?: TFunction;
};
const response1 = await client.getExchangeTxs({ limit: 1, sort: 'asc' });
const data1 = response1.data;
// Process data

const response2 = await res1.fetchMore(2); // 2 more
```

## Custom init params

You can set custom fetcher, parser and transformer for library.

```typescript
type TLibOptions = {
  rootUrl: string;
  fetch?: TFunction;
  parse?: TParser;
  transform?: TFunction;
};
```

The path is fetch -> parse -> transform

### Fetch must return string!

Fetch accepts (url, options)
Fetch by default is `fetch(...).then(res => res.text())`

Parse by default is `JSON.parse.bind(JSON)` , you can use `json-bigint`'s parse if you want to add support for bignumbers.

Transform function has next signature by default (it depends on your parse function):

```
({
  __type,
  data,
  ...rest
}) => any
```

Basically you can switch on \_\_type and do transformations.

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