Javascript library for fetching trusted token pricing data from Limestone data ecosystem. 

Javascript library for fetching trusted token pricing data from Limestone data ecosystem

limestone-finance

limestone-api

  "description": "Javascript library for fetching trusted token pricing data from Limestone data ecosystem",

    "test": "jest --config jestconfig.json",

    "format": "prettier --write \"src/**/*.ts\"",

    "prepublishOnly": "yarn test && yarn lint",

    "postversion": "git push && git push --tags",

    "generate-docs": "typedoc ./src/** --out .exp/docs-typedoc"

    "url": "git+https://github.com/limestone-finance/limestone-api.git"

  "author": "Limestone Team <dev@limestone.finance>",

    "Jakub Wojciechowski <jakub@limestone.finance>",

    "Alex Suvorov <alex@limestone.finance>"

    "url": "https://github.com/limestone-finance/limestone-api/issues"

  "homepage": "https://github.com/limestone-finance/limestone-api#readme",

[![License](https://img.shields.io/badge/license-MIT-green)](https://choosealicense.com/licenses/mit/)

[![Github activity](https://img.shields.io/github/commit-activity/m/limestone-finance/limestone-api)](https://github.com/limestone-finance/limestone-api)

[![Discord](https://img.shields.io/discord/786251205008949258?logo=discord)](https://discord.gg/2CT6hN6C)

[![NPM](https://img.shields.io/npm/v/limestone-api)](https://www.npmjs.com/package/limestone-api)

[![Twitter](https://img.shields.io/twitter/follow/limestone_defi?style=flat&logo=twitter)](https://twitter.com/intent/follow?screen_name=limestone_defi)

Limestone API is a Javascript library for fetching trusted token pricing data from [Limestone data ecosystem](https://github.com/limestone-finance/limestone/blob/master/README.md).

It is a Javascript wrapper for [Limestone HTTP Api](docs/HTTP_API.md).

Limestone pricing data is secured on Arweave and protected by the provider's collateral.

[Learn more](https://github.com/limestone-finance/limestone/blob/master/README.md)

You don't need any API keys. Just install the npm package and add a single line of code.

We support BTC, ETH, AR, EUR, and many other crypto and fiat currencies.

[All supported tokens](docs/ALL_SUPPORTED_TOKENS.md)

Limestone API is fully written in Typescript and then compiled to JavaScript.

[Source code](https://github.com/limestone-finance/limestone-api)

This readme should provide you with all the information you need to start using limestone api. If you want to see the full documentation, visit [docs.limestone.finance](https://docs.limestone.finance)

const limestone = require('limestone-api');

### Get the latest price for a single token

const price = await limestone.getPrice("AR");

console.log(price.value); // latest price value for AR token (in USD)

console.log(price.timestamp); // the exact timestamp of the price

💡 Note: All the prices are denominated in USD. You can fetch price data for BTC, ETH, AR, EUR and any other of [ 100+ supported tokens.](docs/ALL_SUPPORTED_TOKENS.md)

You can also use a `symbols` object to explore all available symbols right in the code.

You can use a `symbols` object to explore all available symbols right in the code.

const price = await limestone.getPrice(symbols.AR);

![limestone code example](docs/limestone-symbols-example.gif)

    value: 123.23, // Number: Price value in USD

    timestamp: 1617146511173, // Number: Timestamp (ms) for price

    provider: "I-5rWUehEv-MjdK9gFw09RxfSLQX9DIHxG614Wf8qo0", // String: Provider arweave address

    permawebTx: "V8FUU0BG4kVOJwKWHzgkn1aEFm-eanhqqEXfPFY7pmI", // String: Arweave transaction id

    source: {"coingecko": 123,"sushiswap": 123.23,"uniswap": 123.35}, // Object: Prices from different sources

  <summary>Fetch price using promises</summary>

  // As async/await is only a syntactic sugar on Javascript

  // Promises you can use them in a "standard" way

  const price = limestone.getPrice("AR").then((price) => {

    console.log(price.value); // latest price value for AR token

----------------------------------------------

### Get the latest prices for several tokens

To fetch prices for several tokens use the `getPrice` method and pass an array with any subset of [supported tokens](docs/ALL_SUPPORTED_TOKENS.md).

const prices = await limestone.getPrice(["BTC", "ETH", "AR", "EUR"]);

console.log(prices); // Example output below

console.log(prices["BTC"].value); // latest price value for BTC

console.log(prices["ETH"].value); // latest price value for ETH

console.log(prices["AR"].value); // latest price value for AR

To fetch the latest prices for all available tokens use the `getAllPrices` method.

const prices = await limestone.getAllPrices();

console.log(prices["EUR"].value); // latest price value for EUR

### Get the historical price for a single token

To get the historical price use the `getHistoricalPrice` method.

const price = await limestone.getHistoricalPrice("AR", {

  date: "2021-03-30T12:35:09", // Any convertable to date type

console.log(price.value); // AR price for specific time

💡 Note: `date` argument must be convertable to Date type. You may pass date (e.g. `new Date(2021-04-01)`), timestamp (e.g. `1617709771289`), or just string (e.g. `2021-04-01` or `2021-04-01T12:30:58`).

### Get the historical price for several tokens

To fetch the historical price for several tokens pass an array of symbols to `getHistoricalPrice` method.

		{
		"name": "limestone-api",
		"version": "3.0.2",
		"version": "3.0.3",
		"description": "Javascript library for fetching trusted token pricing data from Limestone data ecosystem",
		@@ -9,3 +9,3 @@ "main": "lib/index.js",
		"build": "tsc",
		"test": "echo hhhh",
		"test": "jest --config jestconfig.json",
		"format": "prettier --write \"src/*/.ts\"",
		@@ -12,0 +12,0 @@ "prepare": "yarn build",

		@@ -67,3 +67,4 @@ # Limestone API

		You can also use a `symbols` object to explore all available symbols right in the code.
		### Available symbols
		You can use a `symbols` object to explore all available symbols right in the code.
		```js
		@@ -75,2 +76,3 @@ import limestone from 'limestone-api';
		```
		![limestone code example](docs/limestone-symbols-example.gif)

		@@ -77,0 +79,0 @@ <br/>

Fixed alerts

Improved metrics