Skip to content

Commit 0fbbc3a

Browse files
author
vlad-outscraper
committed
Update docs
1 parent c882e57 commit 0fbbc3a

File tree

1 file changed

+35
-20
lines changed

1 file changed

+35
-20
lines changed

README.rst

Lines changed: 35 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
Outscraper Python Library
2-
========================
2+
=========================
33

4-
Python SDK that allows using `Outscraper’s
5-
services <https://outscraper.com/services/>`__ and `Outscraper’s
6-
API <https://app.outscraper.com/api-docs>`__.
4+
The library provides convenient access to the `Outscraper
5+
API <https://app.outscraper.com/api-docs>`__ from applications written
6+
in the Python language. Allows using `Outscraper’s
7+
services <https://outscraper.com/services/>`__ from your code.
8+
9+
`API Docs <https://app.outscraper.com/api-docs>`__
710

811
Installation
912
------------
@@ -18,38 +21,41 @@ Python 3+
1821
page <https://pypi.org/project/outscraper/>`__
1922

2023
Initialization
21-
---------------
24+
--------------
2225

2326
.. code:: python
2427
2528
from outscraper import ApiClient
2629
2730
client = ApiClient(api_key='SECRET_API_KEY')
2831
32+
`Link to the profile page to create the API
33+
key <https://app.outscraper.com/profile>`__
34+
2935
Scrape Google Search
30-
---------------------------
36+
--------------------
3137

3238
.. code:: python
3339
34-
# Search for businesses in specific locations:
35-
result = client.google_maps_search('restaurants brooklyn usa', limit=20, language='en')
36-
3740
# Googel Search
38-
result = client.google_search('bitcoin')
41+
results = client.google_search('bitcoin')
42+
43+
# Googel Search News
44+
results = client.google_search_news('election', language='en')
3945
4046
Scrape Google Maps (Places)
4147
---------------------------
4248

4349
.. code:: python
4450
4551
# Search for businesses in specific locations:
46-
result = client.google_maps_search('restaurants brooklyn usa', limit=20, language='en')
52+
results = client.google_maps_search('restaurants brooklyn usa', limit=20, language='en')
4753
4854
# Get data of the specific place by id
49-
result = client.google_maps_search('ChIJrc9T9fpYwokRdvjYRHT8nI4', language='en')
55+
results = client.google_maps_search('ChIJrc9T9fpYwokRdvjYRHT8nI4', language='en')
5056
5157
# Search with many queries (batching)
52-
result = client.google_maps_search([
58+
results = client.google_maps_search([
5359
'restaurants brooklyn usa',
5460
'bars brooklyn usa',
5561
], language='en')
@@ -60,47 +66,50 @@ Scrape Google Maps Reviews
6066
.. code:: python
6167
6268
# Get reviews of the specific place by id
63-
result = client.google_maps_reviews('ChIJrc9T9fpYwokRdvjYRHT8nI4', reviews_limit=20, language='en')
69+
results = client.google_maps_reviews('ChIJrc9T9fpYwokRdvjYRHT8nI4', reviews_limit=20, language='en')
6470
6571
# Get reviews for places found by search query
66-
result = client.google_maps_reviews('Memphis Seoul brooklyn usa', reviews_limit=20, limit=500, language='en')
72+
results = client.google_maps_reviews('Memphis Seoul brooklyn usa', reviews_limit=20, limit=500, language='en')
6773
6874
# Get only new reviews during last 24 hours
6975
from datetime import datetime, timedelta
7076
yesterday_timestamp = int((datetime.now() - timedelta(1)).timestamp())
7177
72-
result = client.google_maps_reviews(
78+
results = client.google_maps_reviews(
7379
'ChIJrc9T9fpYwokRdvjYRHT8nI4', sort='newest', cutoff=yesterday_timestamp, reviews_limit=100, language='en')
7480
7581
Scrape Google Maps Photos
7682
-------------------------
7783

7884
.. code:: python
7985
80-
result = client.google_maps_photos(
86+
results = client.google_maps_photos(
8187
'Trump Tower, NY, USA', photosLimit=20, language='en')
8288
8389
Scrape Google Maps Directions
8490
-----------------------------
8591

8692
.. code:: python
8793
88-
result = client.google_maps_directions(['29.696596, 76.994928 30.7159662444353, 76.8053887016268', '29.696596, 76.994928 30.723065, 76.770169'])
94+
results = client.google_maps_directions(['29.696596, 76.994928 30.7159662444353, 76.8053887016268', '29.696596, 76.994928 30.723065, 76.770169'])
8995
9096
Scrape Google Play Reviews
9197
--------------------------
9298

9399
.. code:: python
94100
95-
result = client.google_play_reviews(
101+
results = client.google_play_reviews(
96102
'com.facebook.katana', reviews_limit=20, language='en')
97103
98104
Emails And Contacts Scraper
99105
---------------------------
100106

101107
.. code:: python
102108
103-
result = client.emails_and_contacts(['outscraper.com'])
109+
results = client.emails_and_contacts(['outscraper.com'])
110+
111+
`More
112+
examples <https://github.com/outscraper/outscraper-python/tree/master/examples>`__
104113

105114
Responses examples
106115
------------------
@@ -404,3 +413,9 @@ Emails & Contacts Scraper response example:
404413
}
405414
}
406415
]
416+
417+
Contributing
418+
------------
419+
420+
Bug reports and pull requests are welcome on GitHub at
421+
https://github.com/outscraper/outscraper-python.

0 commit comments

Comments
 (0)