Table of Contents
- Introduction
- Online Demo
- Authentication
- Base URL
- Development Kits
- General Information
- HTTP Return Codes
- Article Price Impact
- Public
- Trending News Data (public/trending-news-data)
- Trending News Watchlist (public/trending-news-watchlist)
- Trending News Sources (public/trending-news-sources)
- Trending News Source Impact (public/trending-news-source-impact)
- Trending News Statistics (public/trending-news-statistics)
- Trending News Add Keyword (public/trending-news-add-keyword)
- List your own keywords (public/trending-news-list-my-keywords)
- Trending News Remove Keyword (public/trending-news-remove-keyword)
- Requesting Keywords
- Projects based on the API
- Contributing
All of the latest cryptocurrency and related crypto news which is trending today with access to historical data. The API concentrates on providing the following attributes:
- ID
- Title
- Date Array
- Brief
- Source
- Domain
- URL
- Related Keyword(s)
- Keyword Count
- Unique ID
- Image
- Author
- Price Impact
- Tone
- Anger
- Fear
- Joy
- Sadness
- Analytical
- Confident
- Tentative
JSON Payload Example for a successful trending news data request:
{
"id": "3694",
"date":
{
"time_published": "1590754014",
"day": "Friday",
"format1": "2020-05-29",
"format2": "29th May 2020 12:06"
},
"title": "Ethereum Significantly Less Private Than Bitcoin, New Research Shows",
"brief": "Ethereum transactions are even easier to de-anonymize than Bitcoin due to its specifics, but a lot of it comes down to careful usage of mixing tools.",
"keywords": "bitcoin,Ethereum,eth",
"url": "https://cointelegraph.com/news/ethereum-significantly-less-private-than-bitcoin-new-research-shows",
"source": "Cointelegraph",
"image": "https://s3.cointelegraph.com/storage/uploads/view/c5451bc1be38fbdf6de6f025c637f43d.jpg",
"domain": "cointelegraph.com",
"author": "Andrey Shevchenko",
"price_impact_3600s": {
"status": "Still processing.",
"data": []
,
"tone": {
"status": "Subscription required.",
"data": []
}
}
While we provide the related image parameter, you should always seek permission from the appropriate copyright holder for use and publication of any of the data supplied.
The endpoint public/trending-news-watchlist provides the keywords which we currently check the news for.
You can jump through historical news by using the date parameter on the public/trending-news-data.
We have setup a demo site at https://trendingnews.executium.com/examples/ for you to test out the potential of the cryptocurrency trending and historical news API without having to get your hands dirty.
The example concentrates on the price_impact_3600s array. It compiles data for all offered pairs on a date range basis.
PHP API Example Scripts
If you navigate to here you will find a growing list of examples of how you can access the API with only a small amount of PHP knowledge. Too note, some endpoints require POST parameters to be present, while endpoints such as the proceeding can be accessed without.
- https://trendingnews.executium.com/api/v2/public/trending-news-sources
- https://trendingnews.executium.com/api/v2/public/trending-news-statistics
You do not need to authenticate with any API credentials, but ratelimits do apply.
The base URL for using the executium trending-historical-cryptocurrency-news is https://trendingnews.executium.com
We currently have 8 SDKs available for the trending cryptocurrency news endponts, in the shape of java, node, php, python, c++, c#, kotlin and golang SDKs.
We have provided a PHP SDK for trending news. Please review the readme.md at that location for more information.
The Golang SDK for trending news is available for pull. Please review the readme.md available there for more information.
The Python SDK for trending news is available for use. Please review the readme.md available there for more information on how to utilize the Python files.
The Java SDK for crypto trending news is available for use. Please review the README.md available there for more information on how to configure the JAVA files.
The Node SDK for crypto trending news is available for use. Please review the README.md as there are several forms available for the node installation. Both client and express available.
The C++ SDK for crypto trending news is available for use. Please review the README.md as there are several options available for the c++ installation with both linux and windows methods.
The ASP.net SDK for cryptocurrency trending news is available for use. Please review the README.md for installation instructions.
The C# SDK for crypto trending news is available for use. Please review the README.md available there for more information on how to configure the C# files.
The C SDK for crypto trending news is available for use. Please review the README.md.
The Kotlin SDK for crypto trending news is available for use. Please review the README.md available there for more information on how to configure the files.
The R SDK for cryptocurrency trending news is available for use. Please review the README.md available there for more information on how to configure the R files for use.
The Ruby SDK for cryptocurrency trending news is available for use.
The SWIFT SDK for cryptocurrency trending news is available for use.
The VB.net SDK for trending news is available for use.
- The API is available to the public, rate limits and fair use rules apply.
- The base endpoint is:
trendingnews.executium.com - All endpoints return a JSON object.
- There are currently
8 endpointsfor crytocurrency trending news. - For
POSTendpoints, the parameters must be sent as aquery stringor in therequest body. - For
GETendpoints, parameters must be sent as aquery string. - Parameters may be sent in any order.
- If a parameter sent in both the
query stringandrequest body, thequery stringparameter will take priority. - This package is part of the core executium API version 2.
- HTTP
4XXreturn codes are used for malformed requests where the issue exists with the sender. - HTTP
422return code is applied when a user input is unexpected. - HTTP
429return code is used when breaking a request rate limit. - HTTP
418return code is used when an IP has been banned automatically for continuing to send requests after receiving429codes. - HTTP
5XXreturn codes are used for internal errors where the issue is with the executium side.
Within each article you will find the array price_impact. This array provides the following data points for public usage:
- A aggregated price capture 300 seconds before an article was published
- A aggregated price capture 3600 seconds after the article was published
- A difference of after minus before (after-before)
Currently we capture the following pairs:
- BTCUSDT
- ETHUSDT
- ADAUSDT
- XRPUSDT
- ETHBTC
- ADABTC
- XRPBTC
There are addition tiers of price_impact for different before and after price captures.
| Time Period | Before | After | Subscription |
|---|---|---|---|
| 2 Minutes | 30s | 120s | YES |
| 5 Minutes | 60s | 300s | YES |
| 10 Minutes | 90s | 600s | YES |
| 15 Minutes | 90s | 900s | YES |
| 20 Minutes | 90s | 1200s | YES |
| 30 Minutes | 90s | 1800s | YES |
| 60 Minutes | 300s | 3600s | NO |
We use the provided endpoints with exchanges to find an aggregated price for the time period before the piece was published.
The data provided is in a format which provides enough depth in the non-subscription model for a user to be able to manipulate results how they see fit. We do not know, nor make any suggestion that it is useful for whichever method. But, if it can provide you the ability to analyze data, and discount it or count it, then that should prove of some benefit to your organization. Within executium, certain publications can be coupled with tone and timing to trigger buy or sell on strategies.
Trending news data is display on a day per day basis. The date format must be YYYY-MM-DD. You have the additional option to utilize keyword_contains which will enable you to pull back all data on keywords which contain your string. This ability is also extended with title_contains and brief_contains. For multiple keywords to search add a coma (,) onto the string and the system will search for multiple, up to a maximum of 10 per contains.
You can exclude keywords by using exclude_keywords to bypass keywords you do not want returned. This should be a coma seperated list.
POST /api/v2/public/trending-news-data
Parameters:
| Name | MinLength | Required | Default | Description |
|---|---|---|---|---|
| date | 9 | YES | Format YYYY-MM-DD | |
| keyword_contains | NO | Search for a particular keyword in the keyword |
||
| title_contains | NO | Search for a particular keyword in the title |
||
| brief_contains | NO | Search for a particular keyword in the brief |
||
| exclude_keywords | NO | Coma seperated list of keywords to exclude |
"data": [
{
"id": "3694",
"date": {
"time_published": "1590754014",
"day": "Friday",
"format1": "2020-05-29",
"format2": "29th May 2020 12:06"
},
"title": "Ethereum Significantly Less Private Than Bitcoin, New Research Shows",
"brief": "Ethereum transactions are even easier to de-anonymize than Bitcoin due to its specifics, but a lot of it comes down to careful usage of mixing tools.",
"keywords": "bitcoin,Ethereum,eth",
"url": "https://cointelegraph.com/news/ethereum-significantly-less-private-than-bitcoin-new-research-shows",
"source": "Cointelegraph",
"image": "https://s3.cointelegraph.com/storage/uploads/view/c5451bc1be38fbdf6de6f025c637f43d.jpg",
"domain": "cointelegraph.com",
"author": "Andrey Shevchenko",
"price_impact_120s": {
"status": "Subscription required.",
"data": []
},
"price_impact_300s": {
"status": "Subscription required.",
"data": []
},
"price_impact_600s": {
"status": "Subscription required.",
"data": []
},
"price_impact_900s": {
"status": "Subscription required.",
"data": []
},
"price_impact_1200s": {
"status": "Subscription required.",
"data": []
},
"price_impact_1800s": {
"status": "Subscription required.",
"data": []
},
"price_impact_3600s": {
"status": "3 pending",
"data": {
"btcusdt": {
"status": "compiled",
"pair": "BTCUSDT",
"before": "9382.55000000",
"after": "9415.99000000",
"difference": "33.44000000"
},
"ethusdt": {
"status": "compiled",
"pair": "ETHUSDT",
"before": "218.47000000",
"after": "219.82000000",
"difference": "1.35000000"
},
"adausdt": {
"status": "compiled",
"pair": "ADAUSDT",
"before": "0.06299000",
"after": "0.06387000",
"difference": "0.00088000"
},
"xrpusdt": {
"status": "compiled",
"pair": "XRPUSDT",
"before": "0.19750000",
"after": "0.19758000",
"difference": "0.00008000"
},
"ethbtc": {
"status": "pending",
"pair": "ETHBTC"
},
"adabtc": {
"status": "pending",
"pair": "ADABTC"
},
"xrpbtc": {
"status": "pending",
"pair": "XRPBTC"
}
}
}
},
...
...
]This endpoint provides you will the full list of keywords which our trending news topic tracker looks against.
POST /api/v2/public/trending-news-watchlist
Parameters:
| Name | MinLength | Required | Default | Description |
|---|---|---|---|---|
| keyword_contains | NO | Search for a particular keyword in the keyword |
Successful Response Payload:
{
"data": [
{
"id": "1",
"keywords": "btc/usdt",
"recategory": "btcusdt",
"article_count": "0"
},
{
"id": "2",
"keywords": "btcusdt",
"recategory": "btcusdt",
"article_count": "0"
},
{
"id": "3",
"keywords": "bitcoin",
"recategory": "btcusdt",
"article_count": "0"
},
{
"id": "4",
"keywords": "true coin",
"recategory": "btcusdt",
"article_count": "0"
},
{
"id": "5",
"keywords": "ETH/BTC",
"recategory": "ethbtc",
"article_count": "0"
},
}
]A list of all the news sources which have featured in the trending news catalog. Review public/trending-news-statistics for more statistics and whole number counts.
GET /api/v2/public/trending-news-sources
Parameters: None
Successful Response Payload:
{
"data": [
"3rd Watch News",
"9to5Mac",
"About Manchester",
"Actu Crypto.info",
"AiThority",
"allnews.ch",
"alloaadvertiser.com",
"Altcoin Buzz",
"AMBCrypto",
"AMBCrypto English",
"AMEinfo",
}A complete compiled list to provide insight into news sources impact on prices. You can filter the source by using source_contains, which will allow you to concentrate on specific sources you want. The top_ranking_* array contains the all time list of articles that we have stored and their individual impact. The most_recent_* array provides the most reason bull and bear articles from the publication.
It is important to note, that while some publications seem to have a big impact on price, we are not indicating that they we`re the sole reason for the movement. The intention of this endpoint is to provide additional context to whether the press directly impacts prices or if it is just a fluke.
POST /api/v2/public/trending-news-source-impact
Parameters:
| Name | MinLength | Required | Default | Description |
|---|---|---|---|---|
| source_contains | 1 | YES | Provide the exact publication you are looking for, for example, if you was looking for the coin telegraph, you would enter the coin telegraph. Consult the source list for more information. |
Successful Response Payload:
"data":
{
"btcusdt":
{
"Cryptonaute":
{
"total_articles":410,
"sum_impact":"590.12000000",
"top_ranking_bull":[
{
"id":"3836",
"keywords":"bitcoin,Ethereum,eth",
"time_published":"1587020400",
"diff_btcusdt":"233.50000000",
"ago":"11 weeks ago"
},
{
"id":"4011",
"keywords":"bitcoin",
"time_published":"1592204400",
"diff_btcusdt":"90.70000000",
"ago":"2 weeks ago"
},
{
"id":"3831",
"keywords":"Ethereum,eth",
"time_published":"1589439600",
"diff_btcusdt":"63.54000000",
"ago":"7 weeks ago"
},
{
"id":"3777",
"keywords":"Ethereum,eth",
"time_published":"1592377200",
"diff_btcusdt":"37.10000000",
"ago":"2 weeks ago"
},
{
"id":"3839",
"keywords":"Ethereum,eth",
"time_published":"1589204706",
"diff_btcusdt":"34.54000000",
"ago":"7 weeks ago"
}
],
"top_ranking_bear":[
{
"id":"3810",
"keywords":"Ethereum,eth",
"time_published":"1589918155",
"impact":"-16.50000000",
"ago":"6 weeks ago"
}
],
"most_recent_bull":[
{
"id":"4001",
"keywords":"bitcoin",
"time_published":"1593172260",
"diff_btcusdt":"26.14000000",
"ago":"3 days ago"
},
{
"id":"3768",
"keywords":"bitcoin,Ethereum,eth",
"time_published":"1592910300",
"diff_btcusdt":"31.23000000",
"ago":"6 days ago"
},
{
"id":"3773",
"keywords":"Ethereum,eth",
"time_published":"1592812980",
"diff_btcusdt":"10.43000000",
"ago":"1 weeks ago"
},
{
"id":"3792",
"keywords":"Ethereum,eth",
"time_published":"1592496660",
"diff_btcusdt":"2.76000000",
"ago":"2 weeks ago"
},
{
"id":"3777",
"keywords":"Ethereum,eth",
"time_published":"1592377200",
"diff_btcusdt":"37.10000000",
"ago":"2 weeks ago"
}
],
"most_recent_bear":[
{
"id":"3810",
"keywords":"Ethereum,eth",
"time_published":"1589918155",
"impact":"-16.50000000",
"ago":"6 weeks ago"
}
]
},
},
}
Statistics relating to the trending news catalog. The parameter total_keywords_matched can be much higher than total_articles_found as 100s of keywords can be matched to a single article.
The pending_marketdata_inclusion is an indicator of how many articles are still yet to have market data assigned to them. There will be an arrears when it comes to process this data, as we must wait an hour for the price_impact_3600s to trigger.
GET /api/v2/public/trending-news-statistics
Parameters: None
Successful Response Payload:
"data":
{
"keywords_monitored":5270,
"total_articles_found":80886,
"total_keywords_matched":148219,
"pending_marketdata_inclusion":6311,
"history":[
{
"added_in_last_hour":14
},
{
"last_1_hour":0
},
{
"last_24_hours":438
},
{
"last_48_hours":1228
},
{
"last_7_days":4094
},
{
"last_30_days":9133
}
],
"sources":4835,
"last_update":1593852902
},
Only available for subscribers.
POST /api/v2/public/trending-news-add-keyword
Parameters:
| Name | MinLength | Required | Default | Description |
|---|---|---|---|---|
| name | 1 | YES | The keyword you want to track. |
Successful Response Payload:
"data": {
"code": 2001,
"error": "Missing Key"
},Only available for subscribers.
POST /api/v2/public/trending-news-list-my-keywords
Parameters:
| Name | MinLength | Required | Default | Description |
|---|---|---|---|---|
| limit | NO | 10 | ||
| page | NO | 1 |
Successful Response Payload:
"data": {
"code": 2001,
"error": "Missing Key"
},Only available for subscribers.
POST /api/v2/public/trending-news-remove-keyword
Parameters:
| Name | MinLength | Required | Default | Description |
|---|---|---|---|---|
| keywordid | YES | The keyword_id you wish to remove. You can get this information from the public/trending-news-list-my-keywords endpoint. |
Successful Response Payload:
"data": {
"code": 2001,
"error": "Missing Key"
},If you wish to track your own list of keywords, we have subscription models for that.
As follows are some projects which caught our attention that make use of the trending news API
If you have an interesting usage of our API endpoints for trending news (or any of our projects) then feel free to contact us so we can feature you int his readme.