Get ownership search results
curl --request GET \
--url https://api.govfiles.dev/v2/local-businesses/batches/{batch_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"location_count": 250,
"created_at": "2023-11-07T05:31:56Z",
"status": "queued",
"type": "local_business_batch"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Local business ownership
Get ownership search results
GET
/
v2
/
local-businesses
/
batches
/
{batch_id}
Get ownership search results
curl --request GET \
--url https://api.govfiles.dev/v2/local-businesses/batches/{batch_id} \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.govfiles.dev/v2/local-businesses/batches/{batch_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batch_id": "<string>",
"location_count": 250,
"created_at": "2023-11-07T05:31:56Z",
"status": "queued",
"type": "local_business_batch"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Read the current state of a batch owned by the authenticated account. Poll until
A succeeded batch includes the complete result document in
status is succeeded or failed.
curl -s 'https://api.govfiles.dev/v2/local-businesses/batches/batch_01JEXAMPLE' \
-H "X-API-Key: $GOVFILES_API_KEY"
result, including
result.summary, result.credits_charged, and one result per submitted location. The
result is returned inline; there is no separate download endpoint. Polling is not billed.
Every result includes customer_record_id and the submitted restaurant, including
unmatched results.
The API returns 404 both when the batch does not exist and when it belongs to another account.Authorizations
Path Parameters
Batch identifier returned by the create endpoint.
Required string length:
7 - 200Pattern:
^batch_[0-9a-f]+$Response
Current batch state.
- Queued
- Running
- Succeeded
- Failed