API documentation

Cryptomood AsyncAPI 0.0.1 documentation

The Cryptomood AsyncAPI provide you real-time data of market sentiment.

Currently we are providing access to our realtime api via websockets. For the most part, in the events we are using ‘news’ and ‘social’ prefixes/suffixes to distinguish between two main categories. The latter is divided into subcategories, mostly because of different message types. These subcategories are then named after specific social network - ‘twitter’, ‘reddit’, ‘bitmex’, ‘discord’, ‘telegram’.

Each connection should be using provided api key, be it currently available websocket api or request-response based json api, which is intended for the future.

Table of Contents

Connection details

URL Scheme Description
api.cryptomood.b2b.com:{port}/?apiKey={apiKey} ws WebSocket
URL Variables
Name Default value Possible values Description
port 80
  • 80
  • 443
Secure connection (TLS) is available through port 443.
apiKey string Any Your personal api key

Topics

subscribe news.article

Description

Processed articles will be published to this channel

Payload
Name Type Description Accepted values
id string Any
title string Any
content string Any
crawler string Any
pub_date string Any
created string Any
source string Any
images string Any
videos string Any
links string Any
excerpt string Any
lang string Any
summary string Any
weight number Any
a_sentiment number Any
a_impact number Any
a_crypto_assets array(object) Any
a_crypto_assets.label string Any
a_crypto_assets.start number Any
a_crypto_assets.end number Any
a_crypto_assets.text string Any
a_perspons array(object) Any
a_perspons.label string Any
a_perspons.start number Any
a_perspons.end number Any
a_perspons.text string Any
a_companies array(object) Any
a_companies.label string Any
a_companies.start number Any
a_companies.end number Any
a_companies.text string Any
a_organizations array(object) Any
a_organizations.label string Any
a_organizations.start number Any
a_organizations.end number Any
a_organizations.text string Any
a_locations array(object) Any
a_locations.label string Any
a_locations.start number Any
a_locations.end number Any
a_locations.text string Any
a_exchanges array(object) Any
a_exchanges.label string Any
a_exchanges.start number Any
a_exchanges.end number Any
a_exchanges.text string Any
a_misc array(object) Any
a_misc.label string Any
a_misc.start number Any
a_misc.end number Any
a_misc.text string Any
a_tags array(object) Any
a_tags.label string Any
a_tags.start number Any
a_tags.end number Any
a_tags.text string Any
Example of payload (generated)
{
  "id": "string",
  "title": "string",
  "content": "string",
  "crawler": "string",
  "pub_date": "string",
  "created": "string",
  "source": "string",
  "images": "string",
  "videos": "string",
  "links": "string",
  "excerpt": "string",
  "lang": "string",
  "summary": "string",
  "weight": 0,
  "a_sentiment": 0,
  "a_impact": 0,
  "a_crypto_assets": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_perspons": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_companies": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_organizations": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_locations": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_exchanges": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_misc": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_tags": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ]
}

subscribe social.twitter

Description

Payload
Name Type Description Accepted values
id string Any
title string Any
content string Any
crawler string Any
pub_date string Any
created string Any
source string Any
images string Any
videos string Any
links string Any
excerpt string Any
lang string Any
summary string Any
weight number Any
tw_favourite_count number Any
tw_filter_level string Any
tw_id_str string Any
tw_in_reply_to_screen_name string Any
tw_in_reply_to_status_id_str string Any
tw_in_reply_to_user_id_str string Any
tw_is_quote_status string Any
tw_lang string Any
tw_possibly_sensitive boolean Any
tw_quote_count number Any
tw_retweet_count number Any
tw_user_mentions string Any
tw_source string Any
tw_author_created_at string Any
tw_author_default_profile boolean Any
tw_author_default_profile_image string Any
tw_author_followers_count number Any
tw_author_friends_count number Any
tw_author_id_str string Any
tw_author_lang string Any
tw_author_location string Any
tw_author_name string Any
tw_author_screen_name string Any
tw_author_profile_image_url_https string Any
tw_author_statuses_count number Any
tw_categories array(string) Any
a_sentiment number Any
a_impact number Any
a_crypto_assets array(object) Any
a_crypto_assets.label string Any
a_crypto_assets.start number Any
a_crypto_assets.end number Any
a_crypto_assets.text string Any
a_assets array(object) Any
a_assets.label string Any
a_assets.start number Any
a_assets.end number Any
a_assets.text string Any
a_perspons array(object) Any
a_perspons.label string Any
a_perspons.start number Any
a_perspons.end number Any
a_perspons.text string Any
a_companies array(object) Any
a_companies.label string Any
a_companies.start number Any
a_companies.end number Any
a_companies.text string Any
a_locations array(object) Any
a_locations.label string Any
a_locations.start number Any
a_locations.end number Any
a_locations.text string Any
a_exchanges array(object) Any
a_exchanges.label string Any
a_exchanges.start number Any
a_exchanges.end number Any
a_exchanges.text string Any
a_misc array(object) Any
a_misc.label string Any
a_misc.start number Any
a_misc.end number Any
a_misc.text string Any
a_tags array(object) Any
a_tags.label string Any
a_tags.start number Any
a_tags.end number Any
a_tags.text string Any
Example of payload (generated)
{
  "id": "string",
  "title": "string",
  "content": "string",
  "crawler": "string",
  "pub_date": "string",
  "created": "string",
  "source": "string",
  "images": "string",
  "videos": "string",
  "links": "string",
  "excerpt": "string",
  "lang": "string",
  "summary": "string",
  "weight": 0,
  "tw_favourite_count": 0,
  "tw_filter_level": "string",
  "tw_id_str": "string",
  "tw_in_reply_to_screen_name": "string",
  "tw_in_reply_to_status_id_str": "string",
  "tw_in_reply_to_user_id_str": "string",
  "tw_is_quote_status": "string",
  "tw_lang": "string",
  "tw_possibly_sensitive": true,
  "tw_quote_count": 0,
  "tw_retweet_count": 0,
  "tw_user_mentions": "string",
  "tw_source": "string",
  "tw_author_created_at": "string",
  "tw_author_default_profile": true,
  "tw_author_default_profile_image": "string",
  "tw_author_followers_count": 0,
  "tw_author_friends_count": 0,
  "tw_author_id_str": "string",
  "tw_author_lang": "string",
  "tw_author_location": "string",
  "tw_author_name": "string",
  "tw_author_screen_name": "string",
  "tw_author_profile_image_url_https": "string",
  "tw_author_statuses_count": 0,
  "tw_categories": [
    "string"
  ],
  "a_sentiment": 0,
  "a_impact": 0,
  "a_crypto_assets": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_assets": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_perspons": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_companies": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_locations": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_exchanges": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_misc": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_tags": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ]
}

subscribe social.reddit

Description

Payload
Name Type Description Accepted values
id string Any
title string Any
content string Any
crawler string Any
pub_date string Any
created string Any
source string Any
images string Any
videos string Any
links string Any
excerpt string Any
lang string Any
summary string Any
name string Any
permalink string Any
deleted boolean Any
ups number Any
downs number Any
likes boolean Any
author string Any
score number Any
url string Any
domain string Any
subreddit string Any
subreddit_id string Any
is_self boolean Any
selftext string Any
reply_tree array(object) Any
reply_tree.id string Any
reply_tree.name string Any
reply_tree.permalink string Any
reply_tree.created_utc number Any
reply_tree.deleted boolean Any
reply_tree.ups number Any
reply_tree.downs number Any
reply_tree.likes boolean Any
reply_tree.author string Any
reply_tree.link_author string Any
reply_tree.link_url string Any
reply_tree.link_title string Any
reply_tree.body string Any
hidden boolean Any
link_flair_css_class string Any
link_flair_text string Any
num_comments number Any
locked boolean Any
thumbnail string Any
gilded number Any
distinguished string Any
stickied boolean Any
is_reddit_media_domain boolean Any
weight number Any
a_sentiment number Any
a_impact number Any
a_crypto_assets array(object) Any
a_crypto_assets.label string Any
a_crypto_assets.start number Any
a_crypto_assets.end number Any
a_crypto_assets.text string Any
a_cryptocurrencies array(string) Any
a_perspons array(object) Any
a_perspons.label string Any
a_perspons.start number Any
a_perspons.end number Any
a_perspons.text string Any
a_companies array(object) Any
a_companies.label string Any
a_companies.start number Any
a_companies.end number Any
a_companies.text string Any
a_locations array(object) Any
a_locations.label string Any
a_locations.start number Any
a_locations.end number Any
a_locations.text string Any
a_misc array(object) Any
a_misc.label string Any
a_misc.start number Any
a_misc.end number Any
a_misc.text string Any
a_tags array(object) Any
a_tags.label string Any
a_tags.start number Any
a_tags.end number Any
a_tags.text string Any
Example of payload (generated)
{
  "id": "string",
  "title": "string",
  "content": "string",
  "crawler": "string",
  "pub_date": "string",
  "created": "string",
  "source": "string",
  "images": "string",
  "videos": "string",
  "links": "string",
  "excerpt": "string",
  "lang": "string",
  "summary": "string",
  "name": "string",
  "permalink": "string",
  "deleted": true,
  "ups": 0,
  "downs": 0,
  "likes": true,
  "author": "string",
  "score": 0,
  "url": "string",
  "domain": "string",
  "subreddit": "string",
  "subreddit_id": "string",
  "is_self": true,
  "selftext": "string",
  "reply_tree": [
    {
      "id": "string",
      "name": "string",
      "permalink": "string",
      "created_utc": 0,
      "deleted": true,
      "ups": 0,
      "downs": 0,
      "likes": true,
      "author": "string",
      "link_author": "string",
      "link_url": "string",
      "link_title": "string",
      "body": "string"
    }
  ],
  "hidden": true,
  "link_flair_css_class": "string",
  "link_flair_text": "string",
  "num_comments": 0,
  "locked": true,
  "thumbnail": "string",
  "gilded": 0,
  "distinguished": "string",
  "stickied": true,
  "is_reddit_media_domain": true,
  "weight": 0,
  "a_sentiment": 0,
  "a_impact": 0,
  "a_crypto_assets": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_cryptocurrencies": [
    "string"
  ],
  "a_perspons": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_companies": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_locations": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_misc": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_tags": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ]
}

subscribe social.telegram

Description

Payload
Name Type Description Accepted values
id string Any
pub_date string Any
created string Any
user string Any
message string Any
source string Any
crawler string Any
weight number Any
channel_id number Any
channel_subscriber_count number Any
a_sentiment number Any
a_impact number Any
a_crypto_assets array(string) Any
a_assets array(object) Any
a_assets.label string Any
a_assets.start number Any
a_assets.end number Any
a_assets.text string Any
a_perspons array(object) Any
a_perspons.label string Any
a_perspons.start number Any
a_perspons.end number Any
a_perspons.text string Any
a_companies array(object) Any
a_companies.label string Any
a_companies.start number Any
a_companies.end number Any
a_companies.text string Any
a_locations array(object) Any
a_locations.label string Any
a_locations.start number Any
a_locations.end number Any
a_locations.text string Any
a_exchanges array(object) Any
a_exchanges.label string Any
a_exchanges.start number Any
a_exchanges.end number Any
a_exchanges.text string Any
a_misc array(object) Any
a_misc.label string Any
a_misc.start number Any
a_misc.end number Any
a_misc.text string Any
a_tags array(object) Any
a_tags.label string Any
a_tags.start number Any
a_tags.end number Any
a_tags.text string Any
Example of payload (generated)
{
  "id": "string",
  "pub_date": "string",
  "created": "string",
  "user": "string",
  "message": "string",
  "source": "string",
  "crawler": "string",
  "weight": 0,
  "channel_id": 0,
  "channel_subscriber_count": 0,
  "a_sentiment": 0,
  "a_impact": 0,
  "a_crypto_assets": [
    "string"
  ],
  "a_assets": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_perspons": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_companies": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_locations": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_exchanges": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_misc": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_tags": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ]
}

subscribe social.discord

Description

Payload
Name Type Description Accepted values
id string Any
pub_date string Any
created string Any
user string Any
message string Any
source string Any
crawler string Any
channel_id string Any
guild_id string Any
weight number Any
a_sentiment number Any
a_impact number Any
a_crypto_assets array(string) Any
a_assets array(object) Any
a_assets.label string Any
a_assets.start number Any
a_assets.end number Any
a_assets.text string Any
a_perspons array(object) Any
a_perspons.label string Any
a_perspons.start number Any
a_perspons.end number Any
a_perspons.text string Any
a_companies array(object) Any
a_companies.label string Any
a_companies.start number Any
a_companies.end number Any
a_companies.text string Any
a_locations array(object) Any
a_locations.label string Any
a_locations.start number Any
a_locations.end number Any
a_locations.text string Any
a_exchanges array(object) Any
a_exchanges.label string Any
a_exchanges.start number Any
a_exchanges.end number Any
a_exchanges.text string Any
a_misc array(object) Any
a_misc.label string Any
a_misc.start number Any
a_misc.end number Any
a_misc.text string Any
a_tags array(object) Any
a_tags.label string Any
a_tags.start number Any
a_tags.end number Any
a_tags.text string Any
Example of payload (generated)
{
  "id": "string",
  "pub_date": "string",
  "created": "string",
  "user": "string",
  "message": "string",
  "source": "string",
  "crawler": "string",
  "channel_id": "string",
  "guild_id": "string",
  "weight": 0,
  "a_sentiment": 0,
  "a_impact": 0,
  "a_crypto_assets": [
    "string"
  ],
  "a_assets": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_perspons": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_companies": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_locations": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_exchanges": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_misc": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_tags": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ]
}

subscribe social.bitmex

Description

Payload
Name Type Description Accepted values
id string Any
pub_date string Any
created string Any
user string Any
message string Any
source string Any
crawler string Any
weight number Any
a_sentiment number Any
a_impact number Any
a_crypto_assets array(string) Any
a_assets array(object) Any
a_assets.label string Any
a_assets.start number Any
a_assets.end number Any
a_assets.text string Any
a_perspons array(object) Any
a_perspons.label string Any
a_perspons.start number Any
a_perspons.end number Any
a_perspons.text string Any
a_companies array(object) Any
a_companies.label string Any
a_companies.start number Any
a_companies.end number Any
a_companies.text string Any
a_locations array(object) Any
a_locations.label string Any
a_locations.start number Any
a_locations.end number Any
a_locations.text string Any
a_exchanges array(object) Any
a_exchanges.label string Any
a_exchanges.start number Any
a_exchanges.end number Any
a_exchanges.text string Any
a_misc array(object) Any
a_misc.label string Any
a_misc.start number Any
a_misc.end number Any
a_misc.text string Any
a_tags array(object) Any
a_tags.label string Any
a_tags.start number Any
a_tags.end number Any
a_tags.text string Any
Example of payload (generated)
{
  "id": "string",
  "pub_date": "string",
  "created": "string",
  "user": "string",
  "message": "string",
  "source": "string",
  "crawler": "string",
  "weight": 0,
  "a_sentiment": 0,
  "a_impact": 0,
  "a_crypto_assets": [
    "string"
  ],
  "a_assets": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_perspons": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_companies": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_locations": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_exchanges": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_misc": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ],
  "a_tags": [
    {
      "label": "string",
      "start": 0,
      "end": 0,
      "text": "string"
    }
  ]
}

subscribe news.sentiment

Description

Payload
Name Type Description Accepted values
id string Any
time string Any
resolution string Any
asset string Any
negative_sum number Any
negative_count number Any
positive_sum number Any
positive_count number Any
sentiment_avg number Any
open_sentiment_average number Any
high_sentiment_average number Any
low_sentiment_average number Any
close_sentiment_average number Any
Example of payload (generated)
{
  "id": "string",
  "time": "string",
  "resolution": "string",
  "asset": "string",
  "negative_sum": 0,
  "negative_count": 0,
  "positive_sum": 0,
  "positive_count": 0,
  "sentiment_avg": 0,
  "open_sentiment_average": 0,
  "high_sentiment_average": 0,
  "low_sentiment_average": 0,
  "close_sentiment_average": 0
}

subscribe social.sentiment

Description

Payload
Name Type Description Accepted values
id string Any
time string Any
resolution string Any
asset string Any
negative_sum number Any
negative_count number Any
positive_sum number Any
positive_count number Any
sentiment_avg number Any
open_sentiment_average number Any
high_sentiment_average number Any
low_sentiment_average number Any
close_sentiment_average number Any
Example of payload (generated)
{
  "id": "string",
  "time": "string",
  "resolution": "string",
  "asset": "string",
  "negative_sum": 0,
  "negative_count": 0,
  "positive_sum": 0,
  "positive_count": 0,
  "sentiment_avg": 0,
  "open_sentiment_average": 0,
  "high_sentiment_average": 0,
  "low_sentiment_average": 0,
  "close_sentiment_average": 0
}

Schemas

redditCommentMsg

Name Type Description Accepted values
id string Any
name string Any
permalink string Any
created_utc number Any
deleted boolean Any
ups number Any
downs number Any
likes boolean Any
author string Any
link_author string Any
link_url string Any
link_title string Any
body string Any
Example (generated)
{
  "id": "string",
  "name": "string",
  "permalink": "string",
  "created_utc": 0,
  "deleted": true,
  "ups": 0,
  "downs": 0,
  "likes": true,
  "author": "string",
  "link_author": "string",
  "link_url": "string",
  "link_title": "string",
  "body": "string"
}

ner

Name Type Description Accepted values
label string Any
start number Any
end number Any
text string Any
Example (generated)
{
  "label": "string",
  "start": 0,
  "end": 0,
  "text": "string"
}

sentimentPayload

Name Type Description Accepted values
id string Any
time string Any
resolution string Any
asset string Any
negative_sum number Any
negative_count number Any
positive_sum number Any
positive_count number Any
sentiment_avg number Any
open_sentiment_average number Any
high_sentiment_average number Any
low_sentiment_average number Any
close_sentiment_average number Any
Example (generated)
{
  "id": "string",
  "time": "string",
  "resolution": "string",
  "asset": "string",
  "negative_sum": 0,
  "negative_count": 0,
  "positive_sum": 0,
  "positive_count": 0,
  "sentiment_avg": 0,
  "open_sentiment_average": 0,
  "high_sentiment_average": 0,
  "low_sentiment_average": 0,
  "close_sentiment_average": 0
}
Mobile App
Terminal
API
Widgets