Introduction
Welcome to Scrap.io API! You can use this API to access all our API endpoints, such as the Gmap Search API to search on Google Maps, or the Gmap Enrich API to look up Google Maps information related to a domain name, an email or a phone.
The API is organized around REST. All requests should be made over SSL. All request and response bodies, including errors, are encoded in JSON.
We also have some specific language examples to make integration easier. You can switch the programming language of the examples with the tabs in the top right.
The base url for all endpoints is:
https://scrap.io/api/v1/
Authentication
To authorize, use this code:
$url = 'api_endpoint_here';
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'api_endpoint_here'
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers)
json = JSON.parse(response.body)
import requests
import json
url = "api_endpoint_here"
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.post(url, headers=headers)
json = response.json()
curl "api_endpoint_here" \
-H "Authorization: Bearer xxxxxxxxxx"
const axios = require('axios')
const url = 'api_endpoint_here'
const headers = {
Authorization: 'Bearer xxxxxxxxxx',
};
axios.get(url, { headers })
.then((response) => {
const json = response.data;
});
Make sure to replace
xxxxxxxxxxwith your API key.
Scrap.io uses API keys to allow access to the API. You can create a new API key in your security options.
Scrap.io expects for the API key to be included in all API requests to the server as bearer token in a header that looks like the following:
Authorization: Bearer xxxxxxxxxx
Subscription
$url = 'https://scrap.io/api/v1/subscription';
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/subscription'
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/subscription"
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.post(url, headers=headers)
json = response.json()
curl "https://scrap.io/api/v1/subscription" \
-H "Authorization: Bearer xxxxxxxxxx"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/subscription'
const headers = {
Authorization: 'Bearer xxxxxxxxxx',
};
axios.get(url, { headers })
.then((response) => {
const json = response.data;
});
The above code returns JSON structured like this:
{
"plan": "Partner plan",
"active": true,
"on_trial": false,
"pending_cancelation": false,
"renewal_date": "2022-08-05T15:13:18.000000Z",
"features": {
"EXPORT_CREDITS": {
"name": "Export credits",
"consumed": 0,
"remaining": 100000,
"total": 100000
},
"SCRAPING_SPEED": {
"name": "Scraping speed",
"value": "Very high"
},
"SEARCH_CITY": {
"name": "Search by city",
"value": true
},
"SEARCH_ADMIN2_CODE": {
"name": "Search by level 2 division",
"value": true
},
"SEARCH_ADMIN1_CODE": {
"name": "Search by level 1 division",
"value": true
},
"SEARCH_WHOLE_COUNTRY": {
"name": "Search on whole country",
"value": true
},
"ESSENTIAL_SEARCH_FILTERS": {
"name": "Essential search filters",
"value": true
},
"ADVANCED_SEARCH_FILTERS": {
"name": "Advanced search filters",
"value": true
},
"GMAP_EXPORT_ADDITIONAL_FIELDS": {
"name": "GMap additional fields in exports",
"value": true
},
"WEB_EXPORT_ADDITIONAL_FIELDS": {
"name": "Website additional fields in exports",
"value": true
},
"API_ACCESS": {
"name": "API Access",
"value": true
}
}
}
Get subscription details and remaining credits.
HTTP Request
GET https://scrap.io/api/v1/subscription
GMap
Types
$url = 'https://scrap.io/api/v1/gmap/types';
$params = [
'search_term' => 'boulang',
'locale' => 'fr'
];
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/gmap/types'
params = {
search_term: 'boulang',
locale: 'fr'
}
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers, query: params)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/gmap/types"
params = {
"search_term": "boulang",
"locale": "fr"
}
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.get(url, params=params, headers=headers)
json = response.json()
curl -G "https://scrap.io/api/v1/gmap/types" \
-H "Authorization: Bearer xxxxxxxxxx" \
-d "search_term=boulang" \
-d "locale=fr"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/gmap/types'
const params = {
search_term: 'boulang',
locale: 'fr'
}
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.get(url, { params: params }, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
[
{
"id": "bakery",
"text": "Boulangerie"
},
{
"id": "wholesale-bakery",
"text": "Grossiste en boulangerie"
},
{
"id": "bakery-equipment",
"text": "Équipement pour boulangerie"
}
]
This endpoint allows you to search a Gmap type and get its id. Then you can use it in Gmap search endpoint.
You can search in any language (en and fr for now).
HTTP Request
GET https://scrap.io/api/v1/gmap/types
Query Parameters
| Parameter | Default | Required | Description |
|---|---|---|---|
| search_term | no | Term to search for | |
| locale | en | no | Search locale |
Locations
$url = 'https://scrap.io/api/v1/gmap/locations';
$params = [
'country_code' => 'us',
'type' => 'admin1',
'search_term' => 'New',
];
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/gmap/locations'
params = {
country_code: 'us',
type: 'admin1',
search_term: 'New',
}
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers, query: params)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/gmap/locations"
params = {
"country_code": "us",
"type": "admin1",
"search_term": "New",
}
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.get(url, params=params, headers=headers)
json = response.json()
curl -G "https://scrap.io/api/v1/gmap/locations" \
-H "Authorization: Bearer xxxxxxxxxx" \
-d "country_code=us" \
-d "type=admin1" \
-d "search_term=New"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/gmap/locations'
const params = {
country_code: 'us',
type: 'admin1',
search_term: 'New',
}
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.get(url, { params: params }, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
[
{
"id": "NH",
"text": "New Hampshire"
},
{
"id": "NJ",
"text": "New Jersey"
},
{
"id": "NM",
"text": "New Mexico"
},
{
"id": "NY",
"text": "New York"
}
]
This endpoint allows you to search for locations (admin1, admin2 or city) and retrieve its ids.
You can list all the admin1 areas in one country, all the admin2 areas in one admin1 area, search a city inside a country, etc.
Then, you can use the ID in the gmap search endpoint.
HTTP Request
GET https://scrap.io/api/v1/gmap/locations
Query Parameters
| Parameter | Default | Required | Description |
|---|---|---|---|
| country_code | yes | ISO Country code (FR,US, etc.) | |
| type | yes | Type of entity to search for (admin1, admin2, city) | |
| admin1_code | no | Admin 1 code (if you want to restrict to a specific admin 1 division) | |
| admin2_code | no | Admin 2 code (if you want to restrict to a specific admin 2 division) | |
| search_term | no | Term to search for |
Place
$url = 'https://scrap.io/api/v1/gmap/place';
$params = [
'google_id' => '0x3e5f43348a67e24b:0xff45e502e1ceb7e2',
];
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/gmap/place'
params = {
google_id: '0x3e5f43348a67e24b:0xff45e502e1ceb7e2',
}
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers, query: params)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/gmap/place"
params = {
"google_id": "0x3e5f43348a67e24b:0xff45e502e1ceb7e2",
}
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.get(url, params=params, headers=headers)
json = response.json()
curl -G "https://scrap.io/api/v1/gmap/place" \
-H "Authorization: Bearer xxxxxxxxxx" \
-d "google_id=0x3e5f43348a67e24b:0xff45e502e1ceb7e2"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/gmap/place'
const params = {
google_id: '0x3e5f43348a67e24b:0xff45e502e1ceb7e2',
}
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.get(url, { params: params }, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
{
"meta": {
"found": true,
"status": "updating"
},
"data": {
"google_id": "0x3e5f43348a67e24b:0xff45e502e1ceb7e2",
"name": "Burj Khalifa",
"types": [
{
"type": "landmark",
"deleted": false,
"is_main": true
},
{
"type": "tourist-attraction",
"deleted": false,
"is_main": false
}
],
"is_closed": false,
"descriptions": [
"160-story skyscraper & observation deck",
"Spired 828-meter skyscraper with a viewing deck, restaurant, hotel and offices and 11-hectare park."
],
"website": "http://www.burjkhalifa.ae",
"phone": "+971 4 888 8888",
"phone_international": "+97148888888",
"timezone": "Asia/Dubai",
"location_full_address": "Burj Khalifa - 1 Sheikh Mohammed bin Rashid Blvd - Downtown Dubai - Dubai - United Arab Emirates",
"location_borough": "Downtown Dubai",
"location_street_1": "1 Sheikh Mohammed bin Rashid Blvd",
"location_street_2": "1 Sheikh Mohammed bin Rashid Blvd",
"location_city": null,
"location_postal_code": null,
"location_state": "Dubai",
"location_latitude": "25.197197",
"location_longitude": "55.2743764",
"location_country_code": "AE",
"location_admin1_code": "03",
"location_admin2_code": null,
"link": "https://www.google.com/maps/place/Burj+Khalifa/data=!4m2!3m1!1s0x3e5f43348a67e24b:0xff45e502e1ceb7e2!10m1!1e1",
"place_id": "ChIJS-JnijRDXz4R4rfO4QLlRf8",
"owner_name": "Burj Khalifa",
"owner_id": "104965669872746574451",
"price_range": null,
"reviews_id": "-52384020103776286",
"reviews_count": 106266,
"reviews_rating": 4.7,
"reviews_per_score": {
"1": 3303,
"2": 1183,
"3": 2803,
"4": 10414,
"5": 88563
},
"photos_count": "377083+",
"photos": {
"0": "https://lh5.googleusercontent.com/p/AF1QipOCRDiPjJ0c7WKYsuiOF9WkCiXv8cQNp_YeLEZo",
"2": "https://lh5.googleusercontent.com/p/AF1QipPEPJrgd49pNpmeBF3tvZTgut9SZ_q3K5tK1lDz"
},
"characteristics": {
"accessibility": {
"wheelchair-accessible-entrance": "has-wheelchair-accessible-entrance"
}
},
"occupancy": {
"monday": {
"4 AM": "usually-not-busy",
"5 AM": "usually-not-busy",
"6 AM": "usually-not-busy",
"7 AM": "usually-not-busy",
"8 AM": "usually-not-too-busy",
"9 AM": "usually-not-too-busy",
"10 AM": "usually-a-little-busy",
"11 AM": "usually-a-little-busy",
"12 PM": "usually-as-busy-as-it-gets",
"1 PM": "usually-as-busy-as-it-gets",
"2 PM": "usually-as-busy-as-it-gets",
"3 PM": "usually-as-busy-as-it-gets",
"4 PM": "usually-as-busy-as-it-gets",
"5 PM": "usually-as-busy-as-it-gets",
"6 PM": "usually-as-busy-as-it-gets",
"7 PM": "usually-as-busy-as-it-gets",
"8 PM": "usually-as-busy-as-it-gets",
"9 PM": "usually-a-little-busy",
"10 PM": "usually-a-little-busy",
"11 PM": "usually-not-too-busy",
"12 AM": "usually-not-busy",
"1 AM": "usually-not-busy",
"2 AM": "usually-not-busy",
"3 AM": "usually-not-busy"
},
"tuesday": {
"4 AM": "usually-not-busy",
"5 AM": "usually-not-busy",
"6 AM": "usually-not-busy",
"7 AM": "usually-not-too-busy",
"8 AM": "usually-not-too-busy",
"9 AM": "usually-not-too-busy",
"10 AM": "usually-a-little-busy",
"11 AM": "usually-a-little-busy",
"12 PM": "usually-as-busy-as-it-gets",
"1 PM": "usually-as-busy-as-it-gets",
"2 PM": "usually-as-busy-as-it-gets",
"3 PM": "usually-as-busy-as-it-gets",
"4 PM": "usually-as-busy-as-it-gets",
"5 PM": "usually-as-busy-as-it-gets",
"6 PM": "usually-as-busy-as-it-gets",
"7 PM": "usually-as-busy-as-it-gets",
"8 PM": "usually-as-busy-as-it-gets",
"9 PM": "usually-a-little-busy",
"10 PM": "usually-a-little-busy",
"11 PM": "usually-not-too-busy",
"12 AM": "usually-not-too-busy",
"1 AM": "usually-not-busy",
"2 AM": "usually-not-busy",
"3 AM": "usually-not-busy"
},
"wednesday": {
"4 AM": "usually-not-busy",
"5 AM": "usually-not-busy",
"6 AM": "usually-not-busy",
"7 AM": "usually-not-too-busy",
"8 AM": "usually-not-too-busy",
"9 AM": "usually-not-too-busy",
"10 AM": "usually-a-little-busy",
"11 AM": "usually-a-little-busy",
"12 PM": "usually-a-little-busy",
"1 PM": "usually-as-busy-as-it-gets",
"2 PM": "usually-as-busy-as-it-gets",
"3 PM": "usually-as-busy-as-it-gets",
"4 PM": "usually-as-busy-as-it-gets",
"5 PM": "usually-as-busy-as-it-gets",
"6 PM": "usually-as-busy-as-it-gets",
"7 PM": "usually-as-busy-as-it-gets",
"8 PM": "usually-as-busy-as-it-gets",
"9 PM": "usually-a-little-busy",
"10 PM": "usually-not-too-busy",
"11 PM": "usually-not-too-busy",
"12 AM": "usually-not-busy",
"1 AM": "usually-not-busy",
"2 AM": "usually-not-busy",
"3 AM": "usually-not-busy"
},
"thursday": {
"4 AM": "usually-not-busy",
"5 AM": "usually-not-busy",
"6 AM": "usually-not-busy",
"7 AM": "usually-not-too-busy",
"8 AM": "usually-not-too-busy",
"9 AM": "usually-not-too-busy",
"10 AM": "usually-a-little-busy",
"11 AM": "usually-a-little-busy",
"12 PM": "usually-as-busy-as-it-gets",
"1 PM": "usually-as-busy-as-it-gets",
"2 PM": "usually-as-busy-as-it-gets",
"3 PM": "usually-as-busy-as-it-gets",
"4 PM": "usually-as-busy-as-it-gets",
"5 PM": "usually-as-busy-as-it-gets",
"6 PM": "usually-as-busy-as-it-gets",
"7 PM": "usually-as-busy-as-it-gets",
"8 PM": "usually-as-busy-as-it-gets",
"9 PM": "usually-a-little-busy",
"10 PM": "usually-a-little-busy",
"11 PM": "usually-not-too-busy",
"12 AM": "usually-not-too-busy",
"1 AM": "usually-not-busy",
"2 AM": "usually-not-busy",
"3 AM": "usually-not-busy"
},
"friday": {
"4 AM": "usually-not-busy",
"5 AM": "usually-not-busy",
"6 AM": "usually-not-busy",
"7 AM": "usually-not-too-busy",
"8 AM": "usually-not-too-busy",
"9 AM": "usually-not-too-busy",
"10 AM": "usually-a-little-busy",
"11 AM": "usually-a-little-busy",
"12 PM": "usually-a-little-busy",
"1 PM": "usually-as-busy-as-it-gets",
"2 PM": "usually-as-busy-as-it-gets",
"3 PM": "usually-as-busy-as-it-gets",
"4 PM": "usually-as-busy-as-it-gets",
"5 PM": "usually-as-busy-as-it-gets",
"6 PM": "usually-as-busy-as-it-gets",
"7 PM": "usually-as-busy-as-it-gets",
"8 PM": "usually-as-busy-as-it-gets",
"9 PM": "usually-a-little-busy",
"10 PM": "usually-a-little-busy",
"11 PM": "usually-not-too-busy",
"12 AM": "usually-not-too-busy",
"1 AM": "usually-not-busy",
"2 AM": "usually-not-busy",
"3 AM": "usually-not-busy"
},
"saturday": {
"4 AM": "usually-not-busy",
"5 AM": "usually-not-busy",
"6 AM": "usually-not-busy",
"7 AM": "usually-not-too-busy",
"8 AM": "usually-not-too-busy",
"9 AM": "usually-not-too-busy",
"10 AM": "usually-a-little-busy",
"11 AM": "usually-a-little-busy",
"12 PM": "usually-a-little-busy",
"1 PM": "usually-as-busy-as-it-gets",
"2 PM": "usually-as-busy-as-it-gets",
"3 PM": "usually-as-busy-as-it-gets",
"4 PM": "usually-as-busy-as-it-gets",
"5 PM": "usually-as-busy-as-it-gets",
"6 PM": "usually-as-busy-as-it-gets",
"7 PM": "usually-as-busy-as-it-gets",
"8 PM": "usually-as-busy-as-it-gets",
"9 PM": "usually-a-little-busy",
"10 PM": "usually-a-little-busy",
"11 PM": "usually-not-too-busy",
"12 AM": "usually-not-too-busy",
"1 AM": "usually-not-busy",
"2 AM": "usually-not-busy",
"3 AM": "usually-not-busy"
},
"sunday": {
"4 AM": "usually-not-busy",
"5 AM": "usually-not-busy",
"6 AM": "usually-not-busy",
"7 AM": "usually-not-busy",
"8 AM": "usually-not-too-busy",
"9 AM": "usually-not-too-busy",
"10 AM": "usually-not-too-busy",
"11 AM": "usually-a-little-busy",
"12 PM": "usually-a-little-busy",
"1 PM": "usually-as-busy-as-it-gets",
"2 PM": "usually-as-busy-as-it-gets",
"3 PM": "usually-as-busy-as-it-gets",
"4 PM": "usually-as-busy-as-it-gets",
"5 PM": "usually-as-busy-as-it-gets",
"6 PM": "usually-as-busy-as-it-gets",
"7 PM": "usually-as-busy-as-it-gets",
"8 PM": "usually-as-busy-as-it-gets",
"9 PM": "usually-a-little-busy",
"10 PM": "usually-not-too-busy",
"11 PM": "usually-not-too-busy",
"12 AM": "usually-not-busy",
"1 AM": "usually-not-busy",
"2 AM": "usually-not-busy",
"3 AM": "usually-not-busy"
}
},
"is_claimed": true,
"working_hours": {
"monday": "open-24-hours",
"tuesday": "open-24-hours",
"wednesday": "open-24-hours",
"thursday": "open-24-hours",
"friday": "open-24-hours",
"saturday": "open-24-hours",
"sunday": "open-24-hours"
},
"status": "pending",
"scraped_at": "2022-06-12T12:43:50.000000Z",
"first_seen_at": "2021-04-12T16:25:50.000000Z",
"website_data": {
"url": "http://www.burjkhalifa.ae",
"domain": "burjkhalifa.ae",
"is_responding": true,
"is_empty": null,
"title": "Buy Online & Book Now to Visit the Burj Khalifa | Burj Khalifa",
"meta_keywords": null,
"meta_description": "Burj Khalifa is the tallest tower in the world and it’s one of the top attractions to visit in Dubai. Visit our website and book your Burj Khalifa tickets!",
"meta_og_title": "Buy Online & Book Now to Visit the Burj Khalifa | Burj Khalifa",
"meta_og_image": null,
"meta_generator": null,
"lang": "/e",
"contact_pages": [
"http://www.burjkhalifa.ae/en/contact-us",
"http://www.burjkhalifa.ae/ar/contact-us"
],
"facebook": [
"https://facebook.com/burjkhalifa"
],
"youtube": [
"https://youtube.com/channel/UCKvfrKJ2qRF4Aw487-dCzUw"
],
"twitter": [
"https://twitter.com/burjkhalifa"
],
"instagram": [
"https://instagram.com/burjkhalifa"
],
"linkedin": null,
"technologies": [
"Google Tag Manager"
],
"ad_pixels": [
"Google Tag Manager"
],
"emails": [
{
"email": "[email protected]",
"sources": [
"https://www.burjkhalifa.ae/en/the-burj-club/gym/",
"https://www.burjkhalifa.ae/en/the-burj-club/spa/",
"https://www.burjkhalifa.ae/en/the-burj-club/rooftop/"
]
},
{
"email": "[email protected]",
"sources": [
"https://www.burjkhalifa.ae/en/privacy-policy/"
]
},
{
"email": "[email protected]",
"sources": [
"https://www.burjkhalifa.ae/en/open-call/"
]
},
{
"email": "[email protected]",
"sources": [
"https://www.burjkhalifa.ae/en/schools/"
]
},
{
"email": "[email protected]",
"sources": [
"https://www.burjkhalifa.ae/en/events/"
]
}
],
"phones": [
{
"phone": "+97148883900",
"sources": [
"https://www.burjkhalifa.ae/en/the-burj-club/gym/",
"https://www.burjkhalifa.ae/en/the-burj-club/spa/",
"https://www.burjkhalifa.ae/en/the-burj-club/rooftop/"
]
},
{
"phone": "+971480036227",
"sources": [
"https://www.burjkhalifa.ae/en/privacy-policy/"
]
}
],
"status": "completed",
"scraped_at": "2022-06-12T12:48:07.000000Z"
}
}
}
This endpoint allows you to get all data related to a google place (by google_id or place_id).
HTTP Request
GET https://scrap.io/api/v1/gmap/place
Query Parameters
| Parameter | Default | Required | Description |
|---|---|---|---|
| google_id | no | Google id (ex: 0xabc:0xdef) | |
| place_id | no | Place id (ex: ChIabcDeFGhIJkLMnoPqR) | |
| skip_data | 0 | no | Boolean (0 = false or 1 = true) to indicate that you want to skip the data part of the response. When the data is skipped, it won't deduct any export credit. |
Search
$url = 'https://scrap.io/api/v1/gmap/search';
$params = [
'country_code' => 'us',
'admin1_code' => 'NY',
'city' => 'New York',
'type' => 'restaurant'
];
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/gmap/search'
params = {
country_code: 'us',
admin1_code: 'NY',
city: 'New York',
type: 'restaurant'
}
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers, query: params)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/gmap/search"
params = {
"country_code": "us",
"admin1_code": "NY",
"city": "New York",
"type": "restaurant"
}
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.get(url, params=params, headers=headers)
json = response.json()
curl -G "https://scrap.io/api/v1/gmap/search" \
-H "Authorization: Bearer xxxxxxxxxx" \
-d "country_code=us" \
-d "admin1_code=NY" \
-d "city=New York" \
-d "type=restaurant"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/gmap/search'
const params = {
country_code: 'us',
admin1_code: 'NY',
city: 'New York',
type: 'restaurant'
}
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.get(url, { params: params }, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
{
"meta": {
"count": "4092",
"status": "completed",
"next_cursor": "eyJnbWFwX3BsYWNlX2lkIjo0NTE0NjQsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
"previous_cursor": null,
"per_page": 10,
"has_more_pages": true
},
"data": [
{
"google_id": "0x89c259a17dedfa2b:0x6f033e0043942344",
"name": "SUGARFISH by sushi nozawa",
"types": [
{
"type": "restaurant",
"deleted": false,
"is_main": true
},
{
"type": "sushi-restaurant",
"deleted": false,
"is_main": false
}
],
"is_closed": false,
"descriptions": [
"SUGARFISH, a food-centric full-service restaurant, features a unique omakase-style service based on Nozawa’s 50 plus years of experience in Japan and the US. The menu features only tradition-based sushi of the highest quality, offered in four \"Trust Me®\" options, as well as an array of a la carte sashimi, sushi, and hand rolls made with carefully sourced fish, warm and loosely-packed rice, and crisp nori. SUGARFISH has locations in Los Angeles and New York City. For more information follow SUGARFISH on Instagram, Facebook and Twitter.",
"Acclaimed sushi & sake destination",
"Celebrated local sushi chain serving traditional rolls & sake in a chic, intimate space."
],
"website": "https://sugarfishsushi.com/locations/flatiron",
"phone": "+1 347-705-8100",
"phone_international": "+13477058100",
"timezone": "America/New_York",
"location_full_address": "SUGARFISH by sushi nozawa, 33 E 20th St, New York, NY 10003, United States",
"location_borough": "Manhattan",
"location_street_1": "33 E 20th St",
"location_street_2": "33 E 20th St",
"location_city": "New York",
"location_postal_code": "10003",
"location_state": "New York",
"location_latitude": "40.739001",
"location_longitude": "-73.9888323",
"location_country_code": "US",
"location_admin1_code": "NY",
"location_admin2_code": "061",
"link": "https://www.google.com/maps/place/SUGARFISH+by+sushi+nozawa/data=!4m2!3m1!1s0x89c259a17dedfa2b:0x6f033e0043942344!10m1!1e1",
"place_id": "ChIJK_rtfaFZwokRRCOUQwA-A28",
"owner_name": "SUGARFISH by sushi nozawa",
"owner_id": "100376796693654910584",
"price_range": "$$$",
"reviews_id": "7999305533994836804",
"reviews_count": 1401,
"reviews_rating": 4.5,
"reviews_per_score": {
"1": 78,
"2": 28,
"3": 67,
"4": 194,
"5": 1034
},
"photos_count": "1179+",
"photos": {
"0": "https://lh5.googleusercontent.com/p/AF1QipND93_nJUKC8a41_q3hsBPb4-PAtQbV-rvH0riE",
"2": "https://lh5.googleusercontent.com/p/AF1QipOnX8thoIENmUO6Soi9ev88XaSHO0bVZQVcWFNC"
},
"characteristics": {
"service-options": {
"delivery": "offers-delivery",
"takeout": "offers-takeout",
"dine-in": "serves-dine-in"
},
"health-and-safety": {
"staff-required-to-disinfect-surfaces-between-visits": "staff-required-to-disinfect-surfaces-between-visits"
},
"highlights": {
"great-tea-selection": "has-great-tea-selection"
},
"popular-for": {
"lunch": "popular-for-lunch",
"dinner": "popular-for-dinner",
"solo-dining": "good-for-solo-dining"
},
"accessibility": {
"wheelchair-accessible-entrance": "has-wheelchair-accessible-entrance",
"wheelchair-accessible-parking-lot": "no-wheelchair-accessible-parking-lot"
},
"offerings": {
"alcohol": "serves-alcohol",
"beer": "serves-beer",
"healthy-options": "serves-healthy-options",
"small-plates": "serves-small-plates",
"wine": "serves-wine"
},
"dining-options": {
"lunch": "serves-lunch",
"dinner": "serves-dinner",
"seating": "has-seating"
},
"atmosphere": {
"casual": "casual",
"cozy": "cozy",
"upscale": "upscale"
},
"crowd": {
"tourists": "popular-with-tourists"
},
"planning": {
"usually-a-wait": "usually-has-a-wait"
},
"payments": {
"debit-cards": "accepts-debit-cards"
}
},
"occupancy": {
"monday": null,
"tuesday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-not-too-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
},
"wednesday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-not-too-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
},
"thursday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-a-little-busy",
"1 p.m.": "usually-a-little-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-a-little-busy",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
},
"friday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-a-little-busy",
"1 p.m.": "usually-a-little-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-as-busy-as-it-gets",
"9 p.m.": "usually-as-busy-as-it-gets",
"10 p.m.": "usually-a-little-busy",
"11 p.m.": "usually-not-too-busy"
},
"saturday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-a-little-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-a-little-busy",
"11 p.m.": "usually-not-too-busy"
},
"sunday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "closed",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-not-too-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-a-little-busy",
"7 p.m.": "usually-a-little-busy",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-not-too-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
}
},
"is_claimed": true,
"working_hours": {
"monday": "closed",
"tuesday": "1130am-11pm",
"wednesday": "1130am-11pm",
"thursday": "1130am-11pm",
"friday": "1130am-12am",
"saturday": "1130am-12am",
"sunday": "12-11pm"
},
"status": "completed",
"scraped_at": "2022-07-04T10:24:57.000000Z",
"first_seen_at": "2021-04-12T16:25:50.000000Z",
"website_data": {
"url": "https://sugarfishsushi.com/locations/flatiron",
"domain": "sugarfishsushi.com",
"is_responding": true,
"is_empty": null,
"title": "Flatiron – SUGARFISH",
"meta_keywords": null,
"meta_description": null,
"meta_og_title": null,
"meta_og_image": null,
"meta_generator": "WordPress 5.8.4",
"lang": "en",
"contact_pages": [
"https://sugarfishsushi.com/contact-us"
],
"facebook": [
"https://facebook.com/sugarfishsushi"
],
"youtube": null,
"twitter": [
"https://twitter.com/sugarfish"
],
"instagram": [
"https://instagram.com/sugarfishbynozawa"
],
"linkedin": null,
"technologies": [
"Apache",
"Google Analytics",
"WordPress",
"PHP",
"MySQL"
],
"ad_pixels": [
"Google Tag Manager"
],
"emails": [
{
"email": "[email protected]",
"sources": [
"https://sugarfishsushi.com/locations/flatiron"
]
},
{
"email": "[email protected]",
"sources": [
"https://sugarfishsushi.com/locations/flatiron"
]
}
],
"phones": null,
"status": "completed",
"scraped_at": "2022-07-04T10:24:53.000000Z"
}
},
...
]
}
With this endpoint, you can search all the google places of a specific category in a specific location, and all their details.
We also provide powerful filters that allow you to fine-tune the search according to your needs, and get exactly the results you want.
HTTP Request
GET https://scrap.io/api/v1/gmap/search
Query Parameters
| Parameter | Default | Required | Description |
|---|---|---|---|
| per_page | no | Number of results per page (1, 10, 25 or 50) | |
| skip_data | no | Boolean (0 = false / 1 = true) to indicate that you want to skip the data part of the response. When the data is skipped, it won't deduct any export credit. | |
| cursor | no | Cursor pagination | |
| type | yes | ID of Gmap type to search for | |
| country_code | yes | ISO Country code (FR, US, etc.) | |
| admin1_code | no | ID of admin1 location to search for | |
| admin2_code | no | ID of admin2 location to search for | |
| city | no | ID of city to search for | |
| postal_code | no | Postal code to search for | |
| gmap_is_main_type | no | Boolean (0 = false / 1 = true) | |
| gmap_is_closed | no | Boolean (0 = false / 1 = true) | |
| gmap_has_website | no | Boolean (0 = false / 1 = true) | |
| gmap_has_phone | no | Boolean (0 = false / 1 = true) | |
| gmap_price_range | no | Price range, e.g. '$', '$$', '$$$' or '$$$$' | |
| gmap_reviews_count_lte | no | Gmap reviews count less or equal than | |
| gmap_reviews_count_lt | no | Gmap reviews count less than | |
| gmap_reviews_count_gte | no | Gmap reviews count greater or equals than | |
| gmap_reviews_count_gt | no | Gmap reviews count greater than | |
| gmap_reviews_rating_lte | no | Gmap reviews rating less or equal than | |
| gmap_reviews_rating_lt | no | Gmap reviews rating less than | |
| gmap_reviews_rating_gte | no | Gmap reviews rating greater or equals than | |
| gmap_reviews_rating_gt | no | Gmap reviews rating greater than | |
| gmap_photos_count_lte | no | Gmap photos count less or equal than | |
| gmap_photos_count_lt | no | Gmap photos count less than | |
| gmap_photos_count_gte | no | Gmap photos count greater or equals than | |
| gmap_photos_count_gt | no | Gmap photos count greater than | |
| gmap_is_claimed | no | Boolean (0 = false / 1 = true) | |
| website_has_title | no | Boolean (0 = false / 1 = true) | |
| website_has_meta_keywords | no | Boolean (0 = false / 1 = true) | |
| website_has_meta_description | no | Boolean (0 = false / 1 = true) | |
| website_has_contact_pages | no | Boolean (0 = false / 1 = true) | |
| website_has_emails | no | Boolean (0 = false / 1 = true) | |
| website_has_phones | no | Boolean (0 = false / 1 = true) | |
| website_has_facebook | no | Boolean (0 = false / 1 = true) | |
| website_has_youtube | no | Boolean (0 = false / 1 = true) | |
| website_has_twitter | no | Boolean (0 = false / 1 = true) | |
| website_has_instagram | no | Boolean (0 = false / 1 = true) | |
| website_has_linkedin | no | Boolean (0 = false / 1 = true) | |
| website_has_ad_pixels | no | Boolean (0 = false / 1 = true) |
Enrich
$url = 'https://scrap.io/api/v1/gmap/enrich';
$params = [
'domain' => 'sugarfishsushi.com'
];
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url . '?' . http_build_query($params));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/gmap/enrich'
params = {
domain: 'sugarfishsushi.com'
}
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers, query: params)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/gmap/enrich"
params = {
"domain": "sugarfishsushi.com"
}
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.get(url, params=params, headers=headers)
json = response.json()
curl -G "https://scrap.io/api/v1/gmap/enrich" \
-H "Authorization: Bearer xxxxxxxxxx" \
-d "domain=sugarfishsushi.com"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/gmap/enrich'
const params = {
domain: 'sugarfishsushi.com'
}
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.get(url, { params: params }, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
{
"meta": {
"count": "16",
"status": "completed",
"next_cursor": "eyJnbWFwX3BsYWNlX2lkIjo0NTE0NjQsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0",
"previous_cursor": null,
"per_page": 10,
"has_more_pages": true
},
"data": [
{
"google_id": "0x89c259a17dedfa2b:0x6f033e0043942344",
"name": "SUGARFISH by sushi nozawa",
"types": [
{
"type": "restaurant",
"deleted": false,
"is_main": true
},
{
"type": "sushi-restaurant",
"deleted": false,
"is_main": false
}
],
"is_closed": false,
"descriptions": [
"SUGARFISH, a food-centric full-service restaurant, features a unique omakase-style service based on Nozawa’s 50 plus years of experience in Japan and the US. The menu features only tradition-based sushi of the highest quality, offered in four \"Trust Me®\" options, as well as an array of a la carte sashimi, sushi, and hand rolls made with carefully sourced fish, warm and loosely-packed rice, and crisp nori. SUGARFISH has locations in Los Angeles and New York City. For more information follow SUGARFISH on Instagram, Facebook and Twitter.",
"Acclaimed sushi & sake destination",
"Celebrated local sushi chain serving traditional rolls & sake in a chic, intimate space."
],
"website": "https://sugarfishsushi.com/locations/flatiron",
"phone": "+1 347-705-8100",
"phone_international": "+13477058100",
"timezone": "America/New_York",
"location_full_address": "SUGARFISH by sushi nozawa, 33 E 20th St, New York, NY 10003, United States",
"location_borough": "Manhattan",
"location_street_1": "33 E 20th St",
"location_street_2": "33 E 20th St",
"location_city": "New York",
"location_postal_code": "10003",
"location_state": "New York",
"location_latitude": "40.739001",
"location_longitude": "-73.9888323",
"location_country_code": "US",
"location_admin1_code": "NY",
"location_admin2_code": "061",
"link": "https://www.google.com/maps/place/SUGARFISH+by+sushi+nozawa/data=!4m2!3m1!1s0x89c259a17dedfa2b:0x6f033e0043942344!10m1!1e1",
"place_id": "ChIJK_rtfaFZwokRRCOUQwA-A28",
"owner_name": "SUGARFISH by sushi nozawa",
"owner_id": "100376796693654910584",
"price_range": "$$$",
"reviews_id": "7999305533994836804",
"reviews_count": 1401,
"reviews_rating": 4.5,
"reviews_per_score": {
"1": 78,
"2": 28,
"3": 67,
"4": 194,
"5": 1034
},
"photos_count": "1179+",
"photos": {
"0": "https://lh5.googleusercontent.com/p/AF1QipND93_nJUKC8a41_q3hsBPb4-PAtQbV-rvH0riE",
"2": "https://lh5.googleusercontent.com/p/AF1QipOnX8thoIENmUO6Soi9ev88XaSHO0bVZQVcWFNC"
},
"characteristics": {
"service-options": {
"delivery": "offers-delivery",
"takeout": "offers-takeout",
"dine-in": "serves-dine-in"
},
"health-and-safety": {
"staff-required-to-disinfect-surfaces-between-visits": "staff-required-to-disinfect-surfaces-between-visits"
},
"highlights": {
"great-tea-selection": "has-great-tea-selection"
},
"popular-for": {
"lunch": "popular-for-lunch",
"dinner": "popular-for-dinner",
"solo-dining": "good-for-solo-dining"
},
"accessibility": {
"wheelchair-accessible-entrance": "has-wheelchair-accessible-entrance",
"wheelchair-accessible-parking-lot": "no-wheelchair-accessible-parking-lot"
},
"offerings": {
"alcohol": "serves-alcohol",
"beer": "serves-beer",
"healthy-options": "serves-healthy-options",
"small-plates": "serves-small-plates",
"wine": "serves-wine"
},
"dining-options": {
"lunch": "serves-lunch",
"dinner": "serves-dinner",
"seating": "has-seating"
},
"atmosphere": {
"casual": "casual",
"cozy": "cozy",
"upscale": "upscale"
},
"crowd": {
"tourists": "popular-with-tourists"
},
"planning": {
"usually-a-wait": "usually-has-a-wait"
},
"payments": {
"debit-cards": "accepts-debit-cards"
}
},
"occupancy": {
"monday": null,
"tuesday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-not-too-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
},
"wednesday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-not-too-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
},
"thursday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-a-little-busy",
"1 p.m.": "usually-a-little-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-a-little-busy",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
},
"friday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-a-little-busy",
"1 p.m.": "usually-a-little-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-as-busy-as-it-gets",
"9 p.m.": "usually-as-busy-as-it-gets",
"10 p.m.": "usually-a-little-busy",
"11 p.m.": "usually-not-too-busy"
},
"saturday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "usually-not-too-busy",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-a-little-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-as-busy-as-it-gets",
"7 p.m.": "usually-as-busy-as-it-gets",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-a-little-busy",
"10 p.m.": "usually-a-little-busy",
"11 p.m.": "usually-not-too-busy"
},
"sunday": {
"6 a.m.": "closed",
"7 a.m.": "closed",
"8 a.m.": "closed",
"9 a.m.": "closed",
"10 a.m.": "closed",
"11 a.m.": "closed",
"12 p.m.": "usually-not-too-busy",
"1 p.m.": "usually-not-too-busy",
"2 p.m.": "usually-a-little-busy",
"3 p.m.": "usually-a-little-busy",
"4 p.m.": "usually-a-little-busy",
"5 p.m.": "usually-a-little-busy",
"6 p.m.": "usually-a-little-busy",
"7 p.m.": "usually-a-little-busy",
"8 p.m.": "usually-a-little-busy",
"9 p.m.": "usually-not-too-busy",
"10 p.m.": "usually-not-too-busy",
"11 p.m.": "closed"
}
},
"is_claimed": true,
"working_hours": {
"monday": "closed",
"tuesday": "1130am-11pm",
"wednesday": "1130am-11pm",
"thursday": "1130am-11pm",
"friday": "1130am-12am",
"saturday": "1130am-12am",
"sunday": "12-11pm"
},
"status": "completed",
"scraped_at": "2022-07-04T10:24:57.000000Z",
"first_seen_at": "2021-04-12T16:25:50.000000Z",
"website_data": {
"url": "https://sugarfishsushi.com/locations/flatiron",
"domain": "sugarfishsushi.com",
"is_responding": true,
"is_empty": null,
"title": "Flatiron – SUGARFISH",
"meta_keywords": null,
"meta_description": null,
"meta_og_title": null,
"meta_og_image": null,
"meta_generator": "WordPress 5.8.4",
"lang": "en",
"contact_pages": [
"https://sugarfishsushi.com/contact-us"
],
"facebook": [
"https://facebook.com/sugarfishsushi"
],
"youtube": null,
"twitter": [
"https://twitter.com/sugarfish"
],
"instagram": [
"https://instagram.com/sugarfishbynozawa"
],
"linkedin": null,
"technologies": [
"Apache",
"Google Analytics",
"WordPress",
"PHP",
"MySQL"
],
"ad_pixels": [
"Google Tag Manager"
],
"emails": [
{
"email": "[email protected]",
"sources": [
"https://sugarfishsushi.com/locations/flatiron"
]
},
{
"email": "[email protected]",
"sources": [
"https://sugarfishsushi.com/locations/flatiron"
]
}
],
"phones": null,
"status": "completed",
"scraped_at": "2022-07-04T10:24:53.000000Z"
}
},
...
]
}
Our API includes a powerful feature that allows you to enrich a domain, URL, email, or phone number with data from Google Maps.
With this endpoint, you can retrieve the google places related to the data provided (domain, url, email, phone), and all their details.
HTTP Request
GET https://scrap.io/api/v1/gmap/enrich
Query Parameters
| Parameter | Required | Description |
|---|---|---|
| per_page | No | Number of results per page (1, 10, 25 or 50) |
| skip_data | No | Boolean (0 = false / 1 = true) to indicate whether to skip the data part of the response. When the data is skipped, it won't deduct any export credit. |
| cursor | No | Cursor pagination |
| url | No | Exact URL mentioned on Google Maps |
| domain | No | Domain mentioned in Google Maps |
| No | Email found on the website of Google Place | |
| phone | No | Phone in international format associated with the Google Place (e.g.: 33139732419) |
Blacklist
Our API includes a feature that allows you to add items to a blacklist by email, domain, Google ID, or Place ID. This ensures that these items will not be displayed in future requests and will not be counted towards your credits.
This feature is particularly useful to avoid re-scraping the same results, and counting your credits again for the same data.
List
$url = 'https://scrap.io/api/v1/blacklist';
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/blacklist'
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.get(url, headers: headers)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/blacklist"
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.get(url, headers=headers)
json = response.json()
curl "https://scrap.io/api/v1/blacklist" \
-H "Authorization: Bearer xxxxxxxxxx"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/blacklist'
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.get(url, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
[
{
"list": "my-list-1",
"nb": 2
},
{
"list": "my-list-2",
"nb": 1
}
]
This endpoint allows you to get the list of all your blacklists.
HTTP Request
GET https://scrap.io/api/v1/blacklist
Add
$url = 'https://scrap.io/api/v1/blacklist/my-list-1';
$params = [
'type' => 'domain',
'data' => 'sugarfishsushi.com'
];
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($params));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/blacklist/my-list-1'
params = {
type: 'domain',
data: 'sugarfishsushi.com'
}
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.post(url, headers: headers, body: params)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/blacklist/my-list-1"
params = {
"type": "domain",
"data": "sugarfishsushi.com"
}
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.post(url, data=params, headers=headers)
json = response.json()
curl -X POST "https://scrap.io/api/v1/blacklist/my-list-1" \
-H "Authorization: Bearer xxxxxxxxxx" \
-d "type=domain" \
-d "data=sugarfishsushi.com"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/blacklist/my-list-1'
const params = {
type: 'domain',
data: 'sugarfishsushi.com'
}
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.post(url, params, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
{
"message": "success"
}
This endpoint allows you to add data to a blacklist (google_id, place_id, domain or email).
HTTP Request
POST https://scrap.io/api/v1/blacklist/{list-name}
Query Parameters
| Parameter | Default | Required | Description |
|---|---|---|---|
| type | yes | Type of data to add to the blacklist (google_id,place_id,domain,email) | |
| data | yes | Data to add to the blacklist |
Delete
$url = 'https://scrap.io/api/v1/blacklist/my-list-1';
$headers = [
'Authorization: Bearer xxxxxxxxxx'
];
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "DELETE");
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($curl);
curl_close($curl);
$json = json_decode($response);
require 'httparty'
require 'json'
url = 'https://scrap.io/api/v1/blacklist/my-list-1'
headers = {
Authorization: 'Bearer xxxxxxxxxx',
}
response = HTTParty.delete(url, headers: headers)
json = JSON.parse(response.body)
import requests
import json
url = "https://scrap.io/api/v1/blacklist/my-list-1"
headers = {
"Authorization": "Bearer xxxxxxxxxx"
}
response = requests.delete(url, headers=headers)
json = response.json()
curl -X DELETE "https://scrap.io/api/v1/blacklist/my-list-1" \
-H "Authorization: Bearer xxxxxxxxxx"
const axios = require('axios')
const url = 'https://scrap.io/api/v1/blacklist/my-list-1'
const headers = {
headers: { Authorization: 'Bearer xxxxxxxxxx' },
}
axios.delete(url, headers)
.then((response) => {
json = JSON.parse(response.data)
});
The above code returns JSON structured like this:
{
"message": "success"
}
This endpoint allows you to delete a list.
HTTP Request
DELETE https://scrap.io/api/v1/blacklist/{list-name}
Errors
The Scrap.io API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 401 | Unauthorized -- Your API key is wrong, or not authorized to access this endpoint. |
| 404 | Not Found -- The resource was not be found. |
| 405 | Method Not Allowed -- You tried to access an endpoint with an invalid method. |
| 422 | Unprocessable entity -- Your request is invalid. |
| 429 | Too Many Requests -- You're making too many resquests! Slow down! |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |