Download a dataset snapshot
curl --request GET \
--url https://api.hfsaa.org/v1/dataset/locations.json \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hfsaa.org/v1/dataset/locations.json"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hfsaa.org/v1/dataset/locations.json', 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.hfsaa.org/v1/dataset/locations.json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.hfsaa.org/v1/dataset/locations.json"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.hfsaa.org/v1/dataset/locations.json")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hfsaa.org/v1/dataset/locations.json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dataset_version": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"location_count": 1,
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "restaurant",
"name": "Example Restaurant",
"verification_url": "https://hfsaa-public-locator.pages.dev/?certificate_id=HFSAA-R-EXAMPLE",
"certification_status": "certified",
"chapter_name": "New York",
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"cuisine_type": "Mediterranean",
"google_place_id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA"
}
]
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}Metadata
Download a dataset snapshot
Downloads the exact immutable JSON artifact identified by a dataset version. Use the version-specific URL returned by GET /v1/dataset to ensure the checksum and artifact refer to the same snapshot.
GET
/
v1
/
dataset
/
locations.json
Download a dataset snapshot
curl --request GET \
--url https://api.hfsaa.org/v1/dataset/locations.json \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.hfsaa.org/v1/dataset/locations.json"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.hfsaa.org/v1/dataset/locations.json', 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.hfsaa.org/v1/dataset/locations.json",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.hfsaa.org/v1/dataset/locations.json"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.hfsaa.org/v1/dataset/locations.json")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hfsaa.org/v1/dataset/locations.json")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"dataset_version": "<string>",
"generated_at": "2023-11-07T05:31:56Z",
"location_count": 1,
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"type": "restaurant",
"name": "Example Restaurant",
"verification_url": "https://hfsaa-public-locator.pages.dev/?certificate_id=HFSAA-R-EXAMPLE",
"certification_status": "certified",
"chapter_name": "New York",
"address": "123 Main Street",
"city": "New York",
"state": "NY",
"zip_code": "10001",
"cuisine_type": "Mediterranean",
"google_place_id": "ChIJd8BlQ2BZwokRAFUEcm_qrcA"
}
]
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}{
"error": {
"code": "invalid_parameter",
"message": "limit must be between 1 and 100."
}
}Authorizations
Use the API key as Authorization: Bearer <api-key>.
Query Parameters
Opaque dataset version. Omit it to download the current snapshot; use the value in the metadata download_url for a checksum-stable download.