Up-to-date simple useragent faker with real world database
Up-to-date simple useragent faker with real world database.
pip install fake-useragent
Or if you have multiple Python / pip versions installed, use pip3
:
pip3 install fake-useragent
Simple usage examples below, see also next chapters in this readme for more advanced usages:
from fake_useragent import UserAgent
ua = UserAgent()
# Get a random browser user-agent string
print(ua.random)
# Or get user-agent string from a specific browser
print(ua.chrome)
# Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36
print(ua.google)
# Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_4) AppleWebKit/537.13 (KHTML, like Gecko) Chrome/24.0.1290.1 Safari/537.13
print(ua['google chrome'])
# Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36
print(ua.firefox)
# Mozilla/5.0 (X11; Linux x86_64; rv:109.0) Gecko/20100101 Firefox/115.0
print(ua.ff)
# Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Firefox/102.0
print(ua.safari)
# Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.2 Safari/605.1.15
Additional features that fake-useragent now offers since v1.2.0.
If you want to specify your own browser list, you can do that via the browsers
argument (default is: ["chrome", "edge", "firefox", "safari"]
).
This example will only return random useragents from Edge and Chrome:
from fake_useragent import UserAgent
ua = UserAgent(browsers=['edge', 'chrome'])
ua.random
Note: Fakeuser-agent knowns about: Chrome, Edge, Firefox and Safari. Other browsers are not popular enough and aren't part of our dataset we use.
If you want to specify your own operating systems, you can do that via the os
argument (default is: ["windows", "macos", "linux"]
).
In this example you will only get Linux useragents back:
from fake_useragent import UserAgent
ua = UserAgent(os='linux')
ua.random
If you want to return more popular useragent strings, you can play with the min_percentage
argument (default is: 0.0
, meaning all useragents will match).
In this example you get only useragents that have a minimum usage percentage of 1.3% (or higher):
from fake_useragent import UserAgent
ua = UserAgent(min_percentage=1.3)
ua.random
Hint: Of-course you can combine all those arguments to you liking!
Since version 1.3.0 we now also offer you the following "get" properties which return the whole Python dictionary of the UA, instead of only the user-agent string:
Warning Raw JSON objects (in a Python dictionaries) are returned "as is". Meaning, this data structure could change in the future!
Be aware that these "get" properties below might not return the same key/value pairs in the future. Use
ua.random
or alike as mentioned above, if you want to use a stable interface.
from fake_useragent import UserAgent
ua = UserAgent()
# Random user-agent dictionary (object)
ua.getRandom
# {'percent': 0.8, 'useragent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36 Edg/116.0.1938.76', 'system': 'Edge 116.0 Win10', 'browser': 'edge', 'version': 116.0, 'os': 'win10'}
# More get properties:
ua.getFirefox
# {'percent': 0.3, 'useragent': 'Mozilla/5.0 (Windows NT 10.0; rv:109.0) Gecko/20100101 Firefox/118.0', 'system': 'Firefox 118.0 Win10', 'browser': 'firefox', 'version': 118.0, 'os': 'win10'}
ua.getChrome
ua.getSafari
ua.getEdge
# And a method with an argument.
# This is exactly the same as using: ua.getFirefox
ua.getBrowser('firefox')
You can override the fallback string using the fallback
parameter, in very rare cases something failed:
import fake_useragent
ua = fake_useragent.UserAgent(fallback='your favorite Browser')
# in case if something went wrong, one more time it is REALLY!!! rare case
ua.random == 'your favorite Browser'
If you will try to get unknown browser:
from fake_useragent import UserAgent
ua = UserAgent()
print(ua.unknown)
#Error occurred during getting browser: randm, but was suppressed with fallback.
#Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/114.0.0.0 Safari/537.36
If you need to safe some attributes from overriding them in UserAgent by __getattr__
method
use safe_attrs
you can pass there attributes names.
At least this will prevent you from raising FakeUserAgentError when attribute not found.
For example, when using fakeuseragent with injections <https://github.com/tailhook/injections>
you need to:
import fake_useragent
ua = fake_useragent.UserAgent(safe_attrs=('__injections__',))
Please, do not use if you don't understand why you need this. This is magic for rarely extreme case.
Make sure that you using latest version!
pip install --upgrade fake-useragent
Or if that isn't working, try to install the latest package version like this (1.4.0
is an example, check what the latest version is on PyPi):
pip install fake-useragent==1.4.0
Check version via the Python console:
import fake_useragent
print(fake_useragent.VERSION)
And you are always welcome to post issues.
Please do not forget to mention the version that you are using.
Since GitHub Actions is unable to reach willshouse.com and has Cloudflare protection. We can run the script below to automatically scrape the user-agent strings from the external data source. The script will copy the JSONlines file to the src/fake_useragent/data
directory. Execute:
./update_data_file.sh
The data JSON file is part of the Python package, see pyproject.toml. Read more about Data files support.
We encourage to use Python virtual environment before installing Pip packages, like so:
python -m virtualenv env
source env/bin/activate
pip install -r requirements.txt
tox
To fix imports using ruff:
pip install -r requirements.txt
ruff check --select="I" --fix .
Fix black code formatting errors:
pip install -r requirements.txt
black .
Note: When ruff v1.0 releases, we most likely move fully towards ruff
instead of black
.
1.4.0 November 24, 2023
1.3.0 October 2, 2023
ua.getRandom
, ua.getFirefox
, ua.getChrome
, ua.getSafari
. And a generic method: ua.getBrowser(..)
(eg. getBrowser('firefox')
)
os
argument 'windows' to check for both win10
and win7
values (previously only checking on win10
), thus returning more UAs1.2.1 August 2, 2023
min_percentage
check1.2.0 August 2, 2023
use_external_data=True
and verify_ssl
are removed. If you use those parameters, just remove it in your code!1.1.3 March 20, 2023
1.1.2 February 8, 2023
1.1.1 December 4, 2022
1.1.0 November 26, 2022
pkg_resource
as fallback mechanism in trying to retrieve the local JSON data file1.0.1 November 10, 2022
importlib-metadata
& importlib-resources
as dependenciesfiles()
workingimportlib_metadata
should now also work on Python version before 3.8MANIFEST.in
file1.0.0 November 17, 2022
myproject.toml
file with package-data
support0.1.14 November 5, 2022
pyproject.toml
build system format + syntax checktox.ini
file0.1.13 October 21, 2022
browsers
argument, allowing you to override the browser names you want to useblack
Python formatter in favour of Flake0.1.12 March 31, 2022
0.1.11 October 4, 2018
s3 + cloudfront
fallback to heroku.com
, cuz someone from Florida did ~25M requests last month0.1.10 February 11, 2018
cloudfront
url0.1.9 February 11, 2018
w3schools.com
renamed IE/Edge
to Edge/IE
heroku.com
fallback to s3 + cloudfront
0.1.8 November 2, 2017
useragentstring.com
Can't connect to local MySQL server through socket
0.1.7 April 2, 2017
0.1.6 April 2, 2017
use_cache_server
do not affected anythingw3schools.com <https://www.w3schools.com/browsers/browsers_stats.asp>
_ moved to https
verify_ssl
options added, by default it is True
(urllib.urlopen
ssl context for Python 2.7.9- and 3.4.3- is not supported)0.1.5 February 28, 2017
ua.edge
alias to Internet ExplorerEdge
statisticuse_cache_server
option addedfake_useragent.settings.HTTP_TIMEOUT
to 5 seconds0.1.4 December 14, 2016
fallback
browser support, in case of unavailable data sourcesfake_useragent.FakeUserAgent
for fake_useragent.UserAgent
fake_useragent.UserAgentError
for fake_useragent.FakeUserAgentError
fake_useragent.settings.HTTP_TIMEOUT
to 3 secondssafe_attrs
for prevent overriding by __getattr__
0.1.3 November 24, 2016
fake_useragent.errors.FakeUserAgentError
in case when there is not way to download datafake_useragent.errors.FakeUserAgentError
instead of None
in case of unknown browsergevent.sleep
support in gevent
patched environment when trying to download dataX.X.X xxxxxxx xx, xxxx
You can visit authors page.