Skip to content

Add company

Add company you would like to receive the local NAP audit for.

Base URL

POST https://app.datashake.com/api/v2/local_naps

Request parameters

KEY DATATYPE REQUIRED DESCRIPTION
company_name string yes Name of the company
phone_number string no The phone number of the company
post_code string no The post code of the company
competitor boolean no Fetch data on company competitors
callback string no URL for callback
external_identifier string no Your response identifier

Tip

We highly recommend that you use the callback functionality instead of polling our servers for results.

Learn more about this functionality in this article: What is the callback functionality?

Company name

Name of the company you want the local NAP audit for.

curl POST 'https://app.datashake.com/api/v2/local_naps?company_name=Brooklyn%20Burgers%20%26%20Beer' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/local_naps"
params = {
    "company_name": "Brooklyn Burgers & Beer"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Company phone

Phone number of the company you want the local NAP audit for.

curl POST 'https://app.datashake.com/api/v2/local_naps?company_name=Brooklyn%20Burgers%20%26%20Beer&phone_number=718-788-145' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/local_naps"
params = {
    "company_name": "Brooklyn Burgers & Beer",
    "phone_number": "718-788-145"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Company postcode

Postcode of the company you want the local NAP audit for.

curl POST 'https://app.datashake.com/api/v2/local_naps?company_name=Brooklyn%20Burgers%20%26%20Beer&phone_number=718-788-145&post_code=11215' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/local_naps"
params = {
    "company_name": "Brooklyn Burgers & Beer",
    "phone_number": "718-788-145",
    "post_code": "11215"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Competitors

Set this parameter to true if you want to fetch data on company competitors.

Default value is false.

curl POST 'https://app.datashake.com/api/v2/local_naps?company_name=Brooklyn%20Burgers%20%26%20Beer&phone_number=718-788-145&post_code=11215&competitors=true' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/local_naps"
params = {
    "company_name": "Brooklyn Burgers & Beer",
    "phone_number": "718-788-145",
    "post_code": "11215",
    "competitors": True
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Callback

Callback is a URL where you would like to receive your task results once the job is complete.

You can find detailed information about this functionality here.

curl POST 'https://app.datashake.com/api/v2/local_naps?company_name=Brooklyn%20Burgers%20%26%20Beer&phone_number=718-788-145&post_code=11215&callabck=https://app.reviewcompany.com/Datashake_callback' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/local_naps"
params = {
    "company_name": "Brooklyn Burgers & Beer",
    "phone_number": "718-788-145",
    "post_code": "11215",
    "callabck": "https://app.reviewcompany.com/Datashake_callback"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

External identifier

If you would like to identify the jobs yourself, you can use external identifier. This value will always be included in our callback payload.

Restriction

The value cannot exceed 255 characters.

curl POST 'https://app.datashake.com/api/v2/local_naps?company_name=Brooklyn%20Burgers%20%26%20Beer&phone_number=718-788-145&post_code=11215&external_identifier=qwerty123' -H 'spiderman-token: 1234567890'
import requests

url = "https://app.datashake.com/api/v2/local_naps"
params = {
    "company_name": "Brooklyn Burgers & Beer",
    "phone_number": "718-788-145",
    "post_code": "11215",
    "external_identifier": "qwerty123"
}
headers = {
    "spiderman-token": "1234567890"
}
response = requests.post(
    url=url,
    params=params,
    headers=headers
}
coming soon
coming soon
coming soon

Response

Our response is a JSON object containing these keys:

KEY DATATYPE DESCRIPTION
success boolean Job outcome
status integer HTTP status code
message string Additional information
job_id integer Job identification

Warning

Remember to store the job_id internally, you will need the value to GET the status for the local NAP audit!

curl POST --url 'https://app.datashake.com/api/v2/local_naps?company_name=Brooklyn%20Burgers%20%26%20Beer&phone_number=718-788-1458&post_code=11215' --header 'spiderman-token: 1234567890'
{
    "job_id": 92222,
    "message": "Added this Local NAP to the queue...",
    "status": 200,
    "success": true
}