Postontarget

URL: https://openapi.it/en/support License: Terms of Service

This web service allows you to purchase company database based on different search parameters

First time here? Generate a new access token

Fields

Calls to find all the parameters recorded which will then be used for the subsequent database search

List of countries

Method that returns the list of countries surveyed

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Country_Query)

Responses

Response Schema: application/json

	Array of objects (Country_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 0,
"query": {"country_code": "IT"
}
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"country_code": "IT",
"country_name_EN": "Italy",
"country_name_IT": "Italia"
}
],
"searchRecords": 1,
"totalRecords": 250,
"success": true,
"message": "",
"error": null
}

List of regions

Method that returns the list of regions divided by country

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Admin1_geo_Query)

Responses

Response Schema: application/json

	Array of objects (Admin1_geo_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 0,
"query": {"ID": "R1410",
"country_code": "IT"
}
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"ID": "R1410",
"admin1_name": "Sicilia",
"admin1_name_ascii": "Sicilia",
"country_code": "IT"
}
],
"searchRecords": 1,
"totalRecords": 3967,
"success": true,
"message": "",
"error": null
}

List of provinces

Method that returns the list of provinces divided by region and country

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Admin2_geo_Query)

Responses

Response Schema: application/json

	Array of objects (Admin2_geo_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 0,
"query": {"country_code": "IT",
"id_admin1": "R1415"
}
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"ID": "P17203",
"admin2_name": "Terni",
"admin2_name_ascii": "Terni",
"country_code": "IT",
"id_admin1": "R1415"
},
{"ID": "P17223",
"admin2_name": "Perugia",
"admin2_name_ascii": "Perugia",
"country_code": "IT",
"id_admin1": "R1415"
}
],
"searchRecords": 2,
"totalRecords": 45298,
"success": true,
"message": "",
"error": null
}

List of number of employees

Method that returns the list of number of employees per company

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Dipendenti_Query)

Responses

Response Schema: application/json

	Array of objects (Dipendenti_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 0,
"query": { }
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"dipendenti": "1 - 9"
},
{"dipendenti": "10 - 19"
},
{"dipendenti": "20 - 49"
},
{"dipendenti": "50 - 249"
},
{"dipendenti": "250 - 499"
},
{"dipendenti": "oltre 500"
}
],
"searchRecords": 6,
"totalRecords": 6,
"success": true,
"message": "",
"error": null
}

List of companies turnover

Method that returns the list of companies turnover ranges in millions

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Fatturato_Query)

Responses

Response Schema: application/json

	Array of objects (Fatturato_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 0,
"query": { }
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"fatturato": "fino a 0,5"
},
{"fatturato": "0,5 - 2,5"
},
{"fatturato": "2,5 - 5"
},
{"fatturato": "5 - 13"
},
{"fatturato": "13 - 25"
},
{"fatturato": "25 - 50"
},
{"fatturato": "50 - 100"
},
{"fatturato": "oltre 100"
}
],
"searchRecords": 8,
"totalRecords": 8,
"success": true,
"message": "",
"error": null
}

List of corporate legal forms

Method that returns the list of corporate legal forms divided by country

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Forma_giuridica_Query)

Responses

Response Schema: application/json

	Array of objects (Forma_giuridica_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 0,
"query": {"country_code": "FR"
}
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"ID": 10,
"forma_giuridica": "SARL",
"country_code": "FR"
},
{"ID": 11,
"forma_giuridica": "SA",
"country_code": "FR"
}
],
"searchRecords": 2,
"totalRecords": 11,
"success": true,
"message": "",
"error": null
}

List of commercial macro-categories

Method that returns the list of commercial macro-categories

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Macrocategorie_Query)

Responses

Response Schema: application/json

	Array of objects (Macrocategorie_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 0,
"query": {"macro_name_IT": "Abiti da sposa e cerimonia"
}
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"ID": 11,
"macro_name_IT": "Abiti da sposa e cerimonia",
"macro_name_EN": "Wedding and formal wear"
}
],
"searchRecords": 1,
"totalRecords": 295,
"success": true,
"message": "",
"error": null
}

List of micro-commercial categories

Method that returns the list of micro-commercial categories divided by macro-categories

Authorizations:

bearerAuth

Request Body schema: application/json

limit	integer Default: "<integer>"
	object (Microcategorie_Query)

Responses

Response Schema: application/json

	Array of objects (Microcategorie_Query) [ items ]
searchRecords	integer
totalRecords	integer
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"limit": 5,
"query": {"id_macro": 6
}
}

Response samples

200
400
404
406
422

Content type

application/json

{"data": [{"ID": 32,
"micro_name_IT": "Abbigliamento industria - forniture ed accessori",
"micro_name_EN": "Industry apparel - supplies and accessories",
"id_macro": 6
},
{"ID": 33,
"micro_name_IT": "Abiti da lavoro ed indumenti protettivi",
"micro_name_EN": "Work clothes and protective clothing",
"id_macro": 6
},
{"ID": 34,
"micro_name_IT": "Abiti usati e stracci",
"micro_name_EN": "Used clothes and rags",
"id_macro": 6
},
{"ID": 35,
"micro_name_IT": "Additivi, coloranti e pigmenti uso industriale",
"micro_name_EN": "Additives, dyes and pigments industrial",
"id_macro": 6
},
{"ID": 36,
"micro_name_IT": "Aghi e spilli",
"micro_name_EN": "Pins and needles",
"id_macro": 6
}
],
"searchRecords": 5,
"totalRecords": 1892,
"success": true,
"message": "",
"error": null
}

Order

Calls for the search, purchase and management of an order of company records

Find company records

This method allows you to search company records according to search parameters, returning a number of available results

Authorizations:

bearerAuth

Request Body schema: application/json

required

object

Responses

Response Schema: application/json

	object (Search_Object)
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"query": {"country_code": "IT",
"admin1_code": "IT.15",
"macro_id": 1
}
}

Response samples

200
400
422

Content type

application/json

{"data": {"total_records": 5379918,
"records_found": 51,
"query": {"country_code": "IT",
"admin1_code": "IT.15",
"macro_id": 1
},
"state": "ricerca_evasa",
"owner": "test@api.altravia.com",
"id_request": "5d4d77b80eb46d074e55ce19"
},
"success": true,
"message": "OK",
"error": null
}

Purchase of personal data

This method allows you to purchase a certain number of company records found following the search

Authorizations:

bearerAuth

Request Body schema: application/json

id_request	string Default: "<string>" Request identifier returned after performing a POST Search
records	integer Default: "<integer>" Number of records that you want to buy

Responses

Response Schema: application/json

	object (Buying_Object)
success	boolean
message	string
error	integer

Request samples

Content type

application/json

{"id_request": "5d4d799c0eb46d074f01947f",
"records": "5"
}

Response samples

Content type

application/json

{"data": {"_id": "5d4d799c0eb46d074f01947f",
"total_records": 5379918,
"records_found": 51,
"query": {"country_code": "IT",
"admin1_code": "IT.15",
"macro_id": 1
},
"state": "accettato",
"owner": "test@api.altravia.com",
"base_price": 0.24,
"credit": 3.5599999999999996,
"date": "09/08/2019",
"download": "https://test.postontarget.com/download/4D7736",
"order_id": "4D7736",
"price": 1.2,
"records_purchased": "5"
},
"success": true,
"message": "OK",
"error": null
}

List of requests

Method that allows you to view all the searches and requests made from your profile

Authorizations:

bearerAuth

Responses

Response Schema: application/json

	Array of Search_Object (object) or Buying_Object (object)[ items ]
success	boolean
message	string
error	integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://postontarget.com/state");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

200
404

Content type

application/json

{"data": [{"_id": "5d4bf7e80eb46d074e55cdeb",
"total_records": 5379918,
"records_found": 60,
"query": {"country_code": "IT",
"admin1_code": "IT.15",
"macro_id": 15
},
"state": "accettato",
"owner": "test@api.altravia.com",
"base_price": 0.24,
"credit": 4.76,
"date": "08/08/2019",
"download": "https://dev.postontarget.com/download/2BECCE",
"order_id": "2BECCE",
"price": 0.24,
"records_purchased": 1
},
{"_id": "5d4d513d0eb46d074f01946a",
"total_records": 5379918,
"records_found": 60,
"query": {"country_code": "IT",
"admin1_code": "IT.15",
"macro_id": 15
},
"state": "ricerca_evasa",
"owner": "test@api.altravia.com"
}
],
"success": true,
"message": "",
"error": null
}

Single request

Method that allows you to view the single request or search related to the id passed in the path

Authorizations:

bearerAuth

path Parameters

_id

required

string

Default: "<string>"

Example: 5d4bf7e80eb46d074e55cdeb

Request / search identifier

Responses

Response Schema: application/json

	Search_Object (object) or Buying_Object (object)
success	boolean
message	string
error	integer

Request samples

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://postontarget.com/state/%7B_id%7D");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer REPLACE_BEARER_TOKEN");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

Response samples

200
404
406

Content type

application/json

{"data": {"_id": "5d4bf7e80eb46d074e55cdeb",
"total_records": 5379918,
"records_found": 60,
"query": {"country_code": "IT",
"admin1_code": "IT.15",
"macro_id": 15
},
"state": "accettato",
"owner": "test@api.altravia.com",
"base_price": 0.24,
"credit": 4.76,
"date": "08/08/2019",
"download": "https://dev.postontarget.com/download/2BECCE",
"order_id": "2BECCE",
"price": 0.24,
"records_purchased": 1
},
"success": true,
"message": "",
"error": null
}