Price a Population Search
See what it costs to search everyone at a company or everyone who attended a school before you start.
POST
/
v3
/
search
/
populations
/
quote
Price a Population Search
curl --request POST \
--url https://api.orbitsearch.com/v3/search/populations/quote \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"population": {
"id": "<string>",
"name": "<string>"
},
"size": 1,
"profile_depth": "partial"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
population: {id: '<string>', name: '<string>'},
size: 1,
profile_depth: 'partial'
})
};
fetch('https://api.orbitsearch.com/v3/search/populations/quote', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orbitsearch.com/v3/search/populations/quote"
payload = {
"population": {
"id": "<string>",
"name": "<string>"
},
"size": 1,
"profile_depth": "partial"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"population": {
"kind": "company",
"id": "<string>",
"name": "<string>"
},
"size": 123,
"profile_depth": "quick",
"credits": 123,
"max_people": 123,
"pricing_version": "<string>"
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}A population search returns everyone in one population: every current employee of a company, or everyone who attended a school. Price it first, then start it with Search a population.
curl -X POST "https://api.orbitsearch.com/v3/search/populations/quote" \
-H "Authorization: Bearer $ORBIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"population": { "kind": "company", "id": "1441", "name": "OpenAI" },
"size": 2400,
"profile_depth": "partial"
}'
Request Body
| Field | Type | Default | Description |
|---|---|---|---|
population.kind | company or school | — | What the population is: the current employees of a company, or the alumni of a school. |
population.id | string | — | The numeric id of the company or school. |
population.name | string | — | The company or school name, 1–200 characters. |
size | integer | null | How many people the population has, when you know it. |
profile_depth | quick, partial, or full | partial | The depth every person in the population is built to. A deeper population costs more: quick costs the least and full the most. |
Response
| Field | Description |
|---|---|
population | The subject you asked about. |
size | The size as given, or null. |
profile_depth | The depth the quote priced. |
credits | The whole cost of the search, as one number. Orbit reserves this amount when the search starts. |
max_people | The most people one population search covers (5,000). |
pricing_version | The pricing catalog version the quote used. |
Body
application/json
Response
The quote.
⌘I
Price a Population Search
curl --request POST \
--url https://api.orbitsearch.com/v3/search/populations/quote \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"population": {
"id": "<string>",
"name": "<string>"
},
"size": 1,
"profile_depth": "partial"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
population: {id: '<string>', name: '<string>'},
size: 1,
profile_depth: 'partial'
})
};
fetch('https://api.orbitsearch.com/v3/search/populations/quote', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.orbitsearch.com/v3/search/populations/quote"
payload = {
"population": {
"id": "<string>",
"name": "<string>"
},
"size": 1,
"profile_depth": "partial"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"population": {
"kind": "company",
"id": "<string>",
"name": "<string>"
},
"size": 123,
"profile_depth": "quick",
"credits": 123,
"max_people": 123,
"pricing_version": "<string>"
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}{
"status": "failed",
"error": {
"code": "<string>",
"message": "<string>",
"requiredCredits": 1,
"remainingCredits": 1
}
}