K2adir/bluebird

Unofficial Python client for Twitter

An unofficial Twitter SDK for Python

Installation

bluebird works with Python +3.7

You can install the bluebird package directly with pip / pip3:

pip install bluebird

Twitter

To work with the Twitter Scraper module you have to import the corresponding module first:

from bluebird import BlueBird

The available methods and its usage are described below.

Query language

For both search and stream methods a JSON-based query language must be used. The query must be specified as a Python dictionary containing a list of fields and global options.

Global options

---

lang

This option will force the tweets to match a given language. The language must be specified with its ISO 639-1 two-letter code (e.g., es for Spanish).

since

This parameter refers to the minimum allowed date. It has to be specified in the YYYY-MM-DD format.

until

This parameter refers to the maximum allowed date. It has to be specified in the YYYY-MM-DD format.

near

It has to be specified with a tuple object composed of a text location and a range in miles (e.g., ('Santiago de Compostela', 15)).

Fields

---

A query can specify multiple fields which are Python dictionaries with one or more keys and values:

items

This is a list of strings, either terms or phrases.

exact

If True, the specified terms or phrases must match exactly as they were written on the tweets (case/latin insensitive). If this flag is set, the target parameter will be ignored.

match

If not specified, the tweets will match every item.

• 'any' (the tweets must match at least one of the items)
• 'none' (the tweets won't match any item)

target

If not specified, the tweets will match ordinary keywords.

• 'hashtag' (tweets containing #item)
• 'mention' (tweets mentioning @item)
• 'from' (tweets written by @item)
• 'to' (tweets that are replies to @item)

Examples

---

Search for tweets containing 'Santiago' and not 'Chile':

query = {
    'fields': [
        {'items': ['Santiago']},
        {'items': ['Chile'], 'match': 'none'},
    ]
}

Search for tweets containing 'Santiago' and not 'Chile' written in Spanish:

query = {
    'fields': [
        {'items': ['Santiago']},
        {'items': ['Chile'], 'match': 'none'},
    ],
    'lang': 'es'
}

Search for tweets containing 'Santiago' and not 'Chile' written in Spanish within a 50-mile radius around Santiago de Compostela.

query = {
    'fields': [
        {'items': ['Santiago']},
        {'items': ['Chile'], 'match': 'none'},
    ],
    'lang': 'es',
    'near': ('Santiago de Compostela', 50)
}

Search for tweets containing 'Santiago' and not 'Chile' written in Spanish within a 50-mile radius around Santiago de Compostela in September 2019.

query = {
    'fields': [
        {'items': ['Santiago']},
        {'items': ['Chile'], 'match': 'none'},
    ],
    'lang': 'es',
    'near': ('Santiago de Compostela', 50),
    'since': '2019-09-01',
    'until': '2019-09-30'
}

Search

Search for the last 20 results:

for tweet in BlueBird().search(query):
    print(tweet)

Search for all the available results:

for tweet in BlueBird().search(query, deep=True):
    print(tweet)

Stream

Search constantly for new results:

for tweet in BlueBird().stream(query)
    print(tweet)

Followings

BlueBird().get_followings(username)

Example:

>>> for username in BlueBird().get_followings('dalvarez37'):
...     print(username)

alfonsopmedina
juancarlosgp_
lafuentejuancar

...

Followers

BlueBird().get_followers(username)

Example:

>>> for username in BlueBird().get_followers('dalvarez37'):
...     print(username)

jsierradelarosa
lafuentejuancar
crismadrid011

...

WARNING! It seems that Twitter has disabled the old endpoints so the following functionalities may not work.

List members

BlueBird().get_list_members(username, list_name)

Example:

>>> for user in BlueBird().get_list_members('dalvarez37', 'xiii-legislatura-congreso'):
...     print(user)

{'name': 'Eva Bravo', 'screen_name': 'EvaBravoBarco', 'id': '1116022190154113030'}
{'name': 'Juan José Cortés', 'screen_name': 'JuanjoCortesHu', 'id': '1110994911741050888'}
{'name': 'José Ignacio Echániz', 'screen_name': 'JIEchaniz', 'id': '1110628846242594820'}

...