@coinset/currency.com v1.0.0-beta.1

@coinset/currency.com

Universal Currency.com API client

:children_crossing: This is not official

Public API

A request for an entry point that does not require authentication.

fetchCryptoAssets

see fetchTokenAssets and fetchTokenCryptoAssets

The assets endpoint is to provide a detailed summary for each cryptocurrency available on the exchange. Docs

example:

import { fetchCryptoAssets } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchCryptoAssets();

returns:

type AssetsResponse = {
  [x: string]: {
    name: string;
    description: string | null;
    can_withdraw: boolean;
    can_deposit: boolean;
    min_withdraw: number | null;
    max_withdraw: number | null;
    maker_fee: number | null;
    taker_fee: number | null;
  };
};

fetchCryptoTicker

The ticker endpoint is to provide a 24-hour pricing and volume summary for each cryptocurrency market pair available on the exchange. Docs

example:

import { fetchCryptoTicker } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchCryptoTicker();

returns:

type CryptoTickerResponse = {
  [x: `${string}/${string}`]: {
    base_currency: string;
    base_volume: null | number;
    description: null | string;
    highest_bid_price: null | number;
    isFrozen: boolean;
    last_price: null | number;
    lowest_ask_price: null | number;
    past_24hrs_high_price: null | number;
    past_24hrs_low_price: null | number;
    past_24hrs_price_change: null | number;
    quote_currency: string;
    quote_volume: null | number;
  };
};

fetchTokenTicker

The ticker endpoint is to provide a 24-hour pricing and volume summary for each market pair available on the exchange. Docs

example:

import { fetchTokenTicker } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenTicker();

returns:

type TokenTickerResponse = {
  [x: `${string}/${string}`]: {
    base_currency: string;
    base_volume: null | number;
    description: null | string;
    highest_bid_price: null | number;
    isFrozen: boolean;
    last_price: null | number;
    lowest_ask_price: null | number;
    past_24hrs_high_price: null | number;
    past_24hrs_low_price: null | number;
    past_24hrs_price_change: null | number;
    quote_currency: string;
    quote_volume: null | number;
  };
};

fetchTokenCryptoTicker

The ticker endpoint is to provide a 24-hour pricing and volume summary for each token market pair available on the exchange. Docs

example:

import { fetchTokenCryptoTicker } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenCryptoTicker();

returns:

type TokenTickerResponse = {
  [x: `${string}/${string}`]: {
    base_currency: string;
    base_volume: null | number;
    description: null | string;
    highest_bid_price: null | number;
    isFrozen: boolean;
    last_price: null | number;
    lowest_ask_price: null | number;
    past_24hrs_high_price: null | number;
    past_24hrs_low_price: null | number;
    past_24hrs_price_change: null | number;
    quote_currency: string;
    quote_volume: null | number;
  };
};

fetchCryptoTrades

The trades endpoint is to return data on all recently completed trades for a given cryptocurrency market pair. Docs

example:

import { fetchCryptoTrades } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchCryptoTrades({ symbol: "BTC/USD" });

parameters:

type CryptoTradesOptions = {
  symbol: `${string}/${string}`;
  type?: Type | undefined;
};

returns:

type TradesResponse = {
  tradeID: number;
  price: number;
  base_volume: number;
  quote_volume: number;
  trade_timestamp: number;
  type: "sell" | "buy";
}[];

fetchCryptoTrades

The trades endpoint is to return data on all recently completed trades for a given cryptocurrency market pair. Docs

example:

import { fetchCryptoTrades } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchCryptoTrades({ symbol: "BTC/USD" });

parameters:

type CryptoTradesOptions = {
  symbol: `${string}/${string}`;
  type?: "sell" | "buy" | undefined;
};

returns:

type TradesResponse = {
  tradeID: number;
  price: number;
  base_volume: number;
  quote_volume: number;
  trade_timestamp: number;
  type: "sell" | "buy";
}[];

fetchTokenTrades

The trades endpoint is to return data on all recently completed trades for a given token market pair. Docs

example:

import { fetchTokenTrades } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenTrades({ symbol: "AAPL" });

parameters:

type TokenTradesOptions = {
  symbol: string;
  type?: "sell" | "buy" | undefined;
};

returns:

type TradesResponse = {
  tradeID: number;
  price: number;
  base_volume: number;
  quote_volume: number;
  trade_timestamp: number;
  type: "sell" | "buy";
}[];

fetchTokenCryptoTrades

The trades endpoint is to return data on all recently completed trades for a given market pair. Docs

example:

import { fetchTokenCryptoTrades } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenCryptoTrades({ symbol: "BTC/USD" });
await fetchTokenCryptoTrades({ symbol: "AAPL" });

parameters:

type TokenTradesOptions = {
  symbol: string;
  type?: "sell" | "buy" | undefined;
};

returns:

type TradesResponse = {
  tradeID: number;
  price: number;
  base_volume: number;
  quote_volume: number;
  trade_timestamp: number;
  type: "sell" | "buy";
}[];

fetchCryptoSummary

Overview of market data. Docs

example:

import { fetchCryptoSummary } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchCryptoSummary();

returns:

type CryptoSummaryResponse = {
  msg: string | null;
  data: Record<`${string}/${string}`, {
    id: number;
    last: number;
    lowestAsk: number;
    highestBid: number;
    percentChange: number;
    baseVolume: number;
    quoteVolume: number;
    isFrozen: null | boolean;
    high24hr: number;
    low24hr: number;
  }>;
};

fetchTokenSummary

Overview of market data. Docs

example:

import { fetchTokenSummary } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenSummary();

returns:

type CryptoSummaryResponse = {
  msg: string | null;
  data: Record<string, {
    id: number;
    last: number;
    lowestAsk: number;
    highestBid: number;
    percentChange: number;
    baseVolume: number;
    quoteVolume: number;
    isFrozen: null | boolean;
    high24hr: number;
    low24hr: number;
  }>;
};

fetchTokenCryptoSummary

Overview of market data. Docs

example:

import { fetchTokenCryptoSummary } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenCryptoSummary();

returns:

type CryptoSummaryResponse = {
  msg: string | null;
  data: Record<string, {
    id: number;
    last: number;
    lowestAsk: number;
    highestBid: number;
    percentChange: number;
    baseVolume: number;
    quoteVolume: number;
    isFrozen: null | boolean;
    high24hr: number;
    low24hr: number;
  }>;
};

fetchCryptoOrderBook

The order book endpoint is to provide a complete order book with full depth returned for a given cryptocurrency market pair. Docs

example:

import { fetchCryptoOrderBook } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchCryptoOrderBook({ symbol: "BTC/USD" });

parameters:

type CryptoOrderBookOptions = {
  symbol: `${string}/${string}`;
  depth?: 0 | 5 | 10 | 20 | 50 | 100 | 500 | undefined;
  level?: number | undefined;
};

returns:

type OrderBookResponse = {
  timestamp: number;
  asks: [number, number][];
  bids: [number, number][];
};

fetchTokenOrderBook

The order book endpoint is to provide a complete order book with full depth returned for a given token market pair. Docs

example:

import { fetchTokenOrderBook } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenOrderBook({ symbol: "AAPL" });

parameters:

type TokenOrderBookOptions = {
  symbol: string;
  depth?: 0 | 5 | 10 | 20 | 50 | 100 | 500 | undefined;
  level?: number | undefined;
};

returns:

type OrderBookResponse = {
  timestamp: number;
  asks: [number, number][];
  bids: [number, number][];
};

fetchTokenCryptoOrderBook

The order book endpoint is to provide a complete order book with full depth returned for a given market pair. Docs

example:

import { fetchTokenCryptoOrderBook } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenCryptoOrderBook({ symbol: "BTC/USD" });
await fetchTokenCryptoOrderBook({ symbol: "AAPL" });

parameters:

type TokenOrderBookOptions = {
  symbol: string;
  depth?: 0 | 5 | 10 | 20 | 50 | 100 | 500 | undefined;
  level?: number | undefined;
};

returns:

type OrderBookResponse = {
  timestamp: number;
  asks: [number, number][];
  bids: [number, number][];
};

fetchCryptoCandles

The assets endpoint is to provide a detailed summary for each cryptocurrency available on the exchange. Docs

example:

import { fetchCryptoCandles } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchCryptoCandles({ symbol: "BTC/USD", interval: "M1" });

parameters:

type CandlesOptions = {
  symbol: `${string}/${string}`;
  interval:
    | "M1"
    | "M3"
    | "M5"
    | "M10"
    | "M15"
    | "M30"
    | "H1"
    | "H4"
    | "D1"
    | "W1";
  limit?: number | undefined;
  startTime?: number | undefined;
  endTime?: number | undefined;
};

returns:

type CandlesResponse = {
  timestamp: number;
  open: number;
  high: number;
  low: number;
  close: number;
}[];

fetchTokenCryptoOhlc

Get OHLC data. Docs

example:

import { fetchTokenCryptoOhlc } from "https://deno.land/x/currency_com@$VERSION/mod.ts";
await fetchTokenCryptoOhlc({ symbol: "BTC/USD", interval: "15m" };

parameters:

type OhlcOptions<T extends string> = {
  symbol: T;
  interval: "1m" | "3m" | "5m" | "15m" | "30m" | "1h" | "4h" | "1d" | "1w";
  since?: number | undefined;
};

returns:

type OhlcResponse = {
  result: {
    timestamp: number;
    open: number;
    high: number;
    low: number;
    close: number;
  }[];
  last: number;
  error: string[];
};