Realtime API¶

Class for working with Realtime Results API.

Example usage¶

>>> from hexpy import HexpySession, RealtimeAPI
>>> session = HexpySession.load_auth_from_file()
>>> realtime_client = RealtimeAPI(session)
>>> realtime_client.list(team_id)
>>> session.close()

Methods¶

list¶

list(team_id: int) -> JSONDict

Get the Monitors which are in Proteus

Arguments

team_id: Integer, The id of the team to which the listed monitors belong.

configure¶

configure(monitor_id: int) -> JSONDict

Configure the Realtime evaluators for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.

enable¶

enable(monitor_id: int) -> JSONDict

Enable Realtime Data.

Arguments

monitor_id: Integer, the id of the monitor being requested.

disbale¶

disbale(monitor_id: int) -> JSONDict

Disable Realtime Data.

Arguments

monitor_id: Integer, the id of the monitor being requested.

detail¶

detail(monitor_id: int) -> JSONDict

Get the Realtime evaluators details for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.

cashtags¶

cashtags(monitor_id: int, start: int = None, top: int = None) -> JSONDict

Get Cashtags associated to a Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
start: Integer, specifies inclusive start date in epoch seconds.
top: Integer, The top N cashtags to retrieve.

hashtags¶

hashtags(monitor_id: int, start: int = None, top: int = None) -> JSONDict

Get Hashtags associated to a Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
start: Integer, specifies inclusive start date in epoch seconds.
top: Integer, The top N hashtags to retrieve.

retweets¶

retweets(monitor_id: int) -> JSONDict

Get the Realtime retweets for the Monitor.

full_retweets¶

full_retweets(monitor_id: int, start: int = None) -> JSONDict

Get the Realtime fullretweets for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
start: Integer, specifies inclusive start date in epoch seconds.

Arguments

monitor_id: Integer, the id of the monitor being requested.

social_guids¶

social_guids(monitor_id: int, doc_type: str, start: int = None, received_after: int = None) -> JSONDict

Get the Realtime social guids for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
doct_type: String, Specifies the document type.
start: Integer, specifies inclusive start date in epoch seconds.
received_after: Integer, Specifies inclusive received after date in epoch seconds.
maxresults: Integer, Specifies maximum results to fetch.

tweets¶

tweets(monitor_id: int, start: int = None) -> JSONDict

Get the Realtime tweets for the Monitor.

full_tweets¶

full_tweets(monitor_id: int, start: int = None) -> JSONDict

Get the Realtime fulltweets for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
start: Integer, specifies inclusive start date in epoch seconds.

volume¶

volume(monitor_id: int, start: int = None, doc_type: List = None) -> JSONDict

Get the Realtime volume for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
start: Integer, specifies inclusive start date in epoch seconds.
doc_type: List, specifies the document type to filter.

volume_by_sentiment¶

volume_by_sentiment(monitor_id: int, start: int, doc_type: str) -> JSONDict

Get the Realtime volume by sentiment for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
start: Integer, specifies inclusive start date in epoch seconds.
doc_type: String, specifies the document type to filter.

volume_by_emotion¶

volume_by_emotion(monitor_id: int, start: int, doc_type: str) -> JSONDict

Get the Realtime volume by emotion for the Monitor.

Arguments

monitor_id: Integer, the id of the monitor being requested.
start: Integer, specifies inclusive start date in epoch seconds.
doc_type: String, specifies the document type to filter.

Source

realtime.py