Introduction

Welcome to the Coinwoke API documentation.

Authentication

This section will be updated shortly.

Errors

This section will be updated shortly.

Codes

400
Bad Request
401
Unauthorized
403
Forbidden
404
Not Found
429
Too Many Requests
500
Internal Server Error

Reasons

offset_out_of_bounds
Offset of a paginated request is beyond the total length.

The error object

Attributes

type
string
Type of the object.
code
number
An HTTP status code value.
message
string
User-friendly description of the error.
reason
string
An enum that specifies the cause of the error.

Type

type Error = {
  type: string,
  code: number,
  message: string,
  reason: string,
};

The page object

Attributes

type
string
Type of the object.
end
number
Index (1-based) of the last item in the page.
items
Array<T>
Items of the page.
has_next
boolean
Whether a next page exists.
has_previous
boolean
Whether a previous page exists.
start
number
Index (1-based) of the first item in the page.
total
number
Total number of items.

Type

type Page<T> = {
  type: string,
  end: number,
  items: Array<T>,
  has_next: boolean,
  has_previous: boolean,
  start: number,
  total: number,
};

Rate Limiting

This section will be updated shortly.

Types

This section will be updated shortly.

Versioning

This section will be updated shortly.

Charts

Coming soon.

Coins

This section will be updated shortly.

The coin object

Attributes

id
string
Unique identifier for the object.
type
string
Type of the object.
delta_1d
?string
Change in price over the last day (24 hours).
delta_1h
?string
Change in price over the last hour (60 minutes).
delta_1w
?string
Change in price over the last week (7 days).
last
?string
Last price volume-weighted across all markets.
market_cap
?string
Market capitalization based on coins in circulation.
name
string
Name of the coin.
rank
number
Rank position amongst all coins.
supply
Object
Supply of coins.
circulating
?string
Amount of coins in circulation.
maximum
?string
Maximum amount of coins.
total
?string
Total amount of coins.
symbol
string
Ticker symbol of the coin.
volume
string
Volume traded over the last 24 hours of the coin.

Type

type Coin = {
  id: string,
  type: string,
  delta_1d: ?string,
  delta_1h: ?string,
  delta_1w: ?string,
  last: ?string,
  market_cap: ?string,
  name: string,
  rank: number,
  supply: {
    circulating: ?string,
    maximum: ?string,
    total: ?string,
  },
  symbol: string,
  volume: string,
};

List all coins

Query Parameters

limit
optional, default is 20
A limit on the number of objects to be returned.
offset
optional, default is 0
An offset on the starting position of the objects.
sort
optional, default is rank
An attribute (specified using dot notation) used to sort objects by.

Returns

A list of coin objects.

Definition

GET https://api.coinwoke.com/v1/coins

Example Request

curl https://api.coinwoke.com/v1/coins

Example Response

{
  "type": "page",
  "end": 20,
  "items": [
    {
      "id": "btc",
      "type": "coin",
      "delta_1d": "-0.04800708",
      "delta_1h": null,
      "delta_1w": null,
      "last": "8228.13743418",
      "market_cap": "138719707664.54080200",
      "name": "Bitcoin",
      "rank": 1,
      "supply": {
        "circulating": "16859187.00000000",
        "maximum": "21000000.00000000",
        "total": null
      },
      "symbol": "BTC",
      "volume": "..."
    },
    ...
  ],
  "has_next": true,
  "has_previous": false,
  "start": 1,
  "total": 854
}

Currencies

This section will be updated shortly.

Retrieve a currency

URL Parameters

id
required
Unique identifier for the object.

Returns

A coin or token object if a valid id was provided.

Definition

GET https://api.coinwoke.com/v1/currencies/:id

Example Request

curl https://api.coinwoke.com/v1/currencies/btc

Example Response

{
  "id": "btc",
  "type": "coin",
  "delta_1d": "-0.04800708",
  "delta_1h": null,
  "delta_1w": null,
  "last": "8228.13743418",
  "market_cap": "138719707664.54080200",
  "name": "Bitcoin",
  "rank": 1,
  "supply": {
    "circulating": "16859187.00000000",
    "maximum": "21000000.00000000",
    "total": null
  },
  "symbol": "BTC",
  "volume": "..."
}

List all currencies

Query Parameters

limit
optional, default is 20
A limit on the number of objects to be returned.
offset
optional, default is 0
An offset on the starting position of the objects.
sort
optional, default is rank
An attribute (specified using dot notation) used to sort objects by.

Returns

A list of coin and/or token objects.

Definition

GET https://api.coinwoke.com/v1/currencies

Example Request

curl https://api.coinwoke.com/v1/currencies

Example Response

{
  "type": "page",
  "end": 20,
  "items": [
    {
      "id": "btc",
      "type": "coin",
      "delta_1d": "-0.04800708",
      "delta_1h": null,
      "delta_1w": null,
      "last": "8228.13743418",
      "market_cap": "138719707664.54080200",
      "name": "Bitcoin",
      "rank": 1,
      "supply": {
        "circulating": "16859187.00000000",
        "maximum": "21000000.00000000",
        "total": null
      },
      "symbol": "BTC",
      "volume": "..."
    },
    ...
  ],
  "has_next": true,
  "has_previous": false,
  "start": 1,
  "total": 854
}

Details

This section will be updated shortly.

The detail object

Attributes

description
optional string
Description of the coin, exchange, or token.
facebook
optional string
Facebook username of the coin, exchange, or token.
github
optional string
GitHub organization name of the coin, exchange, or token.
medium
optional string
Medium profile url of the coin, exchange, or token.
reddit
optional string
Reddit subreddit name of the coin, exchange, or token.
telegram
optional string | Array<string>
Telegram group name(s) of the coin, exchange, or token.
twitter
optional string
Twitter username of the coin, exchange, or token.
website
optional string | Array<string>
Website url(s) of the coin, exchange, or token.
twitter
optional string
Whitepaper url of the coin, exchange, or token.

Type

type Detail = {
  description?: string,
  facebook?: string,
  github?: string,
  location?: string,
  medium?: string,
  reddit?: string,
  telegram?: string | Array<string>,
  twitter?: string,
  website?: string | Array<string>,
  whitepaper?: string,
};

Retrieve a detail

URL Parameters

id
required
Unique identifier for the coin, exchange, or token.

Returns

A detail object if a valid id was provided.

Definition

GET https://api.coinwoke.com/v1/details/:id

Example Request

curl https://api.coinwoke.com/v1/details/btc

Example Response

{
  "description": "Bitcoin is a consensus network that enables a new payment system and a completely digital money. It is the first decentralized peer-to-peer payment network that is powered by its users with no central authority or middlemen.",
  "explorer": [
    "https://blockchain.info",
    "https://blockchair.com/bitcoin/blocks",
    "https://live.blockcypher.com/btc/"
  ],
  "github": "bitcoin",
  "website": "https://bitcoin.org",
  "whitepaper": "https://bitcoin.org/bitcoin.pdf"
}

Exchanges

This section will be updated shortly.

The exchange object

Attributes

id
string
Unique identifier for the object.
type
string
Type of the object.
coins
number
Number of different coins on the exchange.
name
string
Name of the coin.
rank
number
Rank position amongst all exchanges.
tokens
number
Number of different tokens on the exchange.
volume
string
Volume traded over the last 24 hours on the exchange.

Type

type Exchange = {
  id: string,
  type: string,
  coins: number,
  name: string,
  rank: number,
  tokens: number,
  volume: string,
};

Retrieve an exchange

URL Parameters

id
required
Unique identifier for the object.

Returns

An exchange object if a valid id was provided.

Definition

GET https://api.coinwoke.com/v1/exchanges/:id

Example Request

curl https://api.coinwoke.com/v1/exchanges/gdax

Example Response

{
  "id": "okex",
  "type": "exchange",
  "coins": 42,
  "name": "OKEx",
  "rank": 1,
  "tokens": 98,
  "volume": "1887259334.44437790"
}

List all exchanges

Query Parameters

limit
optional, default is 20
A limit on the number of objects to be returned.
offset
optional, default is 0
An offset on the starting position of the objects.
sort
optional, default is rank
An attribute (specified using dot notation) used to sort objects by.

Returns

A list of exchange objects.

Definition

GET https://api.coinwoke.com/v1/exchanges

Example Request

curl https://api.coinwoke.com/v1/exchanges

Example Response

{
  "type": "page",
  "end": 20,
  "items": [
    {
      "id": "okex",
      "type": "exchange",
      "coins": 42,
      "name": "OKEx",
      "rank": 1,
      "tokens": 98,
      "volume": "1887259334.44437790"
    },
    ...
  ],
  "has_next": true,
  "has_previous": false,
  "start": 1,
  "total": 118
}

Markets

This section will be updated shortly.

The market object

Attributes

id
string
Unique identifier for the object.
timestamp
string
Timestamp of the last trade.
type
string
Type of the object.
base
Coin | Token
Base coin or token of the market.
exchange
Exchange
Exchange of the market.
last
string
Last price of the market.
quote
Coin | Fiat | Token
Quote coin, fiat, or token of the market.
rank
number
Rank position amongst all markets.
volume
string
Volume traded over the last 24 hours of the market.

Type

type Market = {
  id: string,
  timestamp: string,
  type: string,
  base: Coin | Token,
  exchange: Exchange,
  last: string,
  quote: Coin | Fiat | Token,
  rank: number,
  volume: string,
};

Retrieve a market

URL Parameters

id
required
Unique identifier for the object.

Returns

A market object if a valid id was provided.

Definition

GET https://api.coinwoke.com/v1/markets/:id

Example Request

curl https://api.coinwoke.com/v1/markets/okex_btc_usdt

Example Response

{
  "id": "okex_btc_usdt",
  "timestamp": "2018-03-01T17:00:19.000Z",
  "type": "market",
  "base": {
    "id": "btc",
    "type": "coin",
    "name": "Bitcoin",
    "symbol": "BTC"
  },
  "exchange": {
    "id": "okex",
    "type": "exchange",
    "name": "OKEx"
  },
  "last": "10744.12532180",
  "quote": {
    "id": "usdt",
    "type": "token",
    "coin": "omni",
    "name": "Tether",
    "symbol": "USDT"
  },
  "rank": 1,
  "volume": "522552721.19840503"
}

List all markets

Query Parameters

limit
optional, default is 20
A limit on the number of objects to be returned.
offset
optional, default is 0
An offset on the starting position of the objects.
partition
optional
A coin, exchange, fiat, or token identifier to partition markets by.
sort
optional, default is rank
An attribute (specified using dot notation) used to sort objects by.

Returns

A list of market objects.

Definition

GET https://api.coinwoke.com/v1/markets

Example Request

curl https://api.coinwoke.com/v1/markets?partition=btc

Example Response

{
  "type": "page",
  "end": 20,
  "items": [
    {
      "id": "bitfinex_btc_usd",
      "timestamp": "2018-02-12T04:13:44.626Z",
      "type": "market",
      "base": {
        "id": "btc",
        "type": "coin",
        "name": "Bitcoin",
        "symbol": "BTC"
      },
      "exchange": {
        "id": "bitfinex",
        "type": "exchange",
        "name": "Bitfinex"
      },
      "last": "8511.00000000",
      "quote": {
        "id": "usd",
        "type": "fiat",
        "symbol": "USD"
      },
      "rank": 3,
      "volume": "440502295.19260901"
    },
    ...
  ],
  "has_next": true,
  "has_previous": false,
  "start": 1,
  "total": 3207
}

Overview

This section will be updated shortly.

Definition

GET https://api.coinwoke.com/v1/overview

Example Request

curl https://api.coinwoke.com/v1/overview

Example Response

{
  "type": "overview",
  "coins": 854,
  "currencies": 1293,
  "exchanges": 118,
  "market_cap": "407853871725.69512939",
  "markets": 6504,
  "tokens": 439,
  "volume": "13558180700.92013359"
}

Tokens

This section will be updated shortly.

The token object

Attributes

id
string
Unique identifier for the object.
type
string
Type of the object.
coin
Coin
The coin that the token resides on.
delta_1d
?string
Change in price over the last day (24 hours).
delta_1h
?string
Change in price over the last hour (60 minutes).
delta_1w
?string
Change in price over the last week (7 days).
last
?string
Last price volume-weighted across all markets.
market_cap
?string
Market capitalization based on tokens in circulation.
name
string
Name of the token.
rank
number
Rank position amongst all tokens.
supply
Object
Supply of coins.
circulating
?string
Amount of tokens in circulation.
maximum
?string
Maximum amount of tokens.
total
?string
Total amount of tokens.
symbol
string
Ticker symbol of the token.
volume
string
Volume traded over the last 24 hours of the token.

Type

type Token = {
  id: string,
  type: string,
  coin: Coin,
  delta_1d: ?string,
  delta_1h: ?string,
  delta_1w: ?string,
  last: ?string,
  market_cap: ?string,
  name: string,
  rank: number,
  supply: {
    circulating: ?string,
    maximum: ?string,
    total: ?string,
  },
  symbol: string,
  volume: string,
};

List all tokens

Query Parameters

limit
optional, default is 20
A limit on the number of objects to be returned.
offset
optional, default is 0
An offset on the starting position of the objects.
sort
optional, default is rank
An attribute (specified using dot notation) used to sort objects by.

Returns

A list of token objects.

Definition

GET https://api.coinwoke.com/v1/tokens

Example Request

curl https://api.coinwoke.com/v1/tokens

Example Response

{
  "type": "page",
  "end": 20,
  "items": [
    {
      "id": "eos",
      "type": "token",
      "coin": {
        "id": "eth",
        "type": "coin",
        "name": "Ethereum"
      },
      "delta_1d": "-0.02516031",
      "delta_1h": null,
      "delta_1w": null,
      "last": "8.60817735",
      "market_cap": "4795228337.00237846",
      "name": "EOS",
      "rank": 1,
      "supply": {
        "circulating": "557055012.00000000",
        "maximum": "1000000000.00000000",
        "total": "900000000.00000000"
      },
      "symbol": "EOS",
      "volume": "..."
    },
    ...
  ],
  "has_next": true,
  "has_previous": false,
  "start": 1,
  "total": 439
}

Coming Soon

This section will be updated shortly.