Coindar API 2.0 Documentation
Description
To get an access to a Coindar API 2.0 you should register a new account and get an access token.
coins
Returns a cryptocurrencies list.
Method
GET
Parameters
access_token (required) — access token.
Example
https://coindar.org/api/v2/coins?access_token={token}
Example of the response
[
{
}
{
"id": "1",
"name": "Bitcoin",
"symbol": "BTC",
"image_32": "https://coindar.org/images/coins/bitcoin/32x32.png",
"image_64": "https://coindar.org/images/coins/bitcoin/64x64.png"
"name": "Bitcoin",
"symbol": "BTC",
"image_32": "https://coindar.org/images/coins/bitcoin/32x32.png",
"image_64": "https://coindar.org/images/coins/bitcoin/64x64.png"
}
id — unique cryptocurrency identificator.
name — cryptocurrency name.
symbol — short name.
image_32 — url of logo with the size of 32x32 pixels.
image_64 — url to logo with the size of 64x64 pixels.
name — cryptocurrency name.
symbol — short name.
image_32 — url of logo with the size of 32x32 pixels.
image_64 — url to logo with the size of 64x64 pixels.
tags
Returns a list of events tags.
Method
GET
Parameters
access_token (required) — access token.
Example
https://coindar.org/api/v2/tags?access_token={token}
Example of the response
[
{
}
{
"id": "1",
"name": "General",
"name": "General",
}
id — unique tag identificator.
name — tag name.
name — tag name.
events
Returns cryptocurrency events.
Method
GET
Parameters
access_token (required) — access token.
page — page number.
By default: 1
page_size — page size.
By default: 30
Possible values: from 1 to 100
filter_date_start — the lower limit of the event start date in the format yyyy-mm-dd.
By default: date of the first event on Coindar.
filter_date_end — the upper date limit of the event start date in the format yyyy-mm-dd.
By default: date of the last event on Coindar by the time of request.
filter_coins — cryptocurrencies IDs, relating to the requested events.
By default: all cryptocurrencies
Example: 1,2,3,4,10
filter_tags — tags IDs (list of tags IDs can be received by the tags method).
By default: all tags
Example: 1,2,3
sort_by — parameter, defining events sorting.
By default: date_start
Possible values: date_start (start date), date_added (publication date), views (amount of views). Remember, that views accounting started in June 2018.
order_by — sorting order
By default: 0
Possible values: 0 (in the increasing order) or 1 (in the decreasing order)
page — page number.
By default: 1
page_size — page size.
By default: 30
Possible values: from 1 to 100
filter_date_start — the lower limit of the event start date in the format yyyy-mm-dd.
By default: date of the first event on Coindar.
filter_date_end — the upper date limit of the event start date in the format yyyy-mm-dd.
By default: date of the last event on Coindar by the time of request.
filter_coins — cryptocurrencies IDs, relating to the requested events.
By default: all cryptocurrencies
Example: 1,2,3,4,10
filter_tags — tags IDs (list of tags IDs can be received by the tags method).
By default: all tags
Example: 1,2,3
sort_by — parameter, defining events sorting.
By default: date_start
Possible values: date_start (start date), date_added (publication date), views (amount of views). Remember, that views accounting started in June 2018.
order_by — sorting order
By default: 0
Possible values: 0 (in the increasing order) or 1 (in the decreasing order)
Example
https://coindar.org/api/v2/events?access_token={token}&page=1&page_size=30&filter_date_start=2018-06-01&filter_date_end=2018-07-01&filter_coins=1,4,20,34&filter_tags=1,2,3&sort_by=views&order_by=1
Example of the response
[
{
}
{
"caption": "Listing on OTCBTC",
"source": "https://coindar.org/en/event/oraclechain-oct-listing-on-otcbtc-11299",
"source_reliable": "true",
"important": "false",
"date_public": "2018-7-09 17:23",
"date_start": "2018-7-11 06:00",
"date_end": "",
"coin_id": "280",
"coin_price_changes": "-12.89",
"tags": "9"
"source": "https://coindar.org/en/event/oraclechain-oct-listing-on-otcbtc-11299",
"source_reliable": "true",
"important": "false",
"date_public": "2018-7-09 17:23",
"date_start": "2018-7-11 06:00",
"date_end": "",
"coin_id": "280",
"coin_price_changes": "-12.89",
"tags": "9"
}
caption — event caption.
source — link to the event description.
source_reliable — true if the event has a reliable source.
important — true if the event is important.
date_public — event publication date on Coindar.
All dates are in UTC and yyyy-mm-dd HH:mm format.
date_start — the date of the event start.
If there is no definiton of time, request will be returned in yyyy-mm-dd format.
If only month is defined, in yyyy-mm.
If only quarter is defined, in yyyy-QX, where X is a quarter number.
date_end — events end date.
coin_id — cryptocurrency's ID.
coin_price_changes — the percentage change in value since the event publication.
tags — tags IDs.
source — link to the event description.
source_reliable — true if the event has a reliable source.
important — true if the event is important.
date_public — event publication date on Coindar.
All dates are in UTC and yyyy-mm-dd HH:mm format.
date_start — the date of the event start.
If there is no definiton of time, request will be returned in yyyy-mm-dd format.
If only month is defined, in yyyy-mm.
If only quarter is defined, in yyyy-QX, where X is a quarter number.
date_end — events end date.
coin_id — cryptocurrency's ID.
coin_price_changes — the percentage change in value since the event publication.
tags — tags IDs.