Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
curl --request GET \
--url http://localhost:3000/v2/datasets \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/datasets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/datasets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/datasets",
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 := "http://localhost:3000/v2/datasets"
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("http://localhost:3000/v2/datasets")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/datasets")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"status": "active",
"availability": "general_availability",
"name": "Brazilian Companies Registry",
"orgId": "org_abc123",
"slug": "brazilian-companies",
"country": "BR",
"description": "<string>",
"price": 50,
"customPrice": false,
"priceCurrency": "USD",
"meteredEvents": [
"queries_tier_4"
],
"queryMode": "manual",
"provider": {
"object": "provider",
"id": "<string>",
"slug": "<string>",
"name": "<string>"
},
"freshness": "<string>",
"targetTypes": [
"company"
],
"featured": false,
"allowMock": true,
"inputSchema": {},
"requestSchema": {},
"responseSchema": {},
"providerRequestSchema": {},
"providerResponseSchema": {},
"requestExample": {},
"responseExample": {},
"usecases": [
"<string>"
],
"outputFields": [
"<string>"
],
"categories": [
"<string>"
],
"collections": [
"<string>"
],
"lastIngestion": "2023-11-07T05:31:56Z",
"ingestionCadence": "<string>",
"providerAccountProviders": [
"<string>"
],
"requestEnvelope": "<string>",
"responseEnvelope": "<string>",
"statusCheck": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"ownerOrgName": "Base39",
"instructions": "<string>",
"location": "South America",
"metadata": {},
"upstreams": [
{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"name": "Federal Revenue",
"description": "<string>",
"logo": "<string>",
"slug": "federal-revenue",
"country": "BR",
"type": "<string>",
"url": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"featured": true
}
],
"incomingShare": {
"id": "<string>",
"datasetId": "<string>",
"ownerOrgDocument": "<string>",
"targetOrgDocument": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"targetUserIds": [
"<string>"
],
"patches": [
{}
],
"userShares": [
{
"id": "<string>",
"datasetShareId": "<string>",
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"patches": [
{}
]
}
]
},
"outgoingShares": [
{
"id": "<string>",
"datasetId": "<string>",
"ownerOrgDocument": "<string>",
"targetOrgDocument": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"targetUserIds": [
"<string>"
],
"patches": [
{}
],
"userShares": [
{
"id": "<string>",
"datasetShareId": "<string>",
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"patches": [
{}
]
}
]
}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"type": "<string>"
}curl --request GET \
--url http://localhost:3000/v2/datasets \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/v2/datasets"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/v2/datasets', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/datasets",
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 := "http://localhost:3000/v2/datasets"
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("http://localhost:3000/v2/datasets")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/datasets")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"object": "list",
"results": [
{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"status": "active",
"availability": "general_availability",
"name": "Brazilian Companies Registry",
"orgId": "org_abc123",
"slug": "brazilian-companies",
"country": "BR",
"description": "<string>",
"price": 50,
"customPrice": false,
"priceCurrency": "USD",
"meteredEvents": [
"queries_tier_4"
],
"queryMode": "manual",
"provider": {
"object": "provider",
"id": "<string>",
"slug": "<string>",
"name": "<string>"
},
"freshness": "<string>",
"targetTypes": [
"company"
],
"featured": false,
"allowMock": true,
"inputSchema": {},
"requestSchema": {},
"responseSchema": {},
"providerRequestSchema": {},
"providerResponseSchema": {},
"requestExample": {},
"responseExample": {},
"usecases": [
"<string>"
],
"outputFields": [
"<string>"
],
"categories": [
"<string>"
],
"collections": [
"<string>"
],
"lastIngestion": "2023-11-07T05:31:56Z",
"ingestionCadence": "<string>",
"providerAccountProviders": [
"<string>"
],
"requestEnvelope": "<string>",
"responseEnvelope": "<string>",
"statusCheck": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"ownerOrgName": "Base39",
"instructions": "<string>",
"location": "South America",
"metadata": {},
"upstreams": [
{
"object": "page",
"id": "p_abc123",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T14:45:00.000Z",
"name": "Federal Revenue",
"description": "<string>",
"logo": "<string>",
"slug": "federal-revenue",
"country": "BR",
"type": "<string>",
"url": "<string>",
"createdBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"updatedBy": {
"object": "user",
"id": "u_abc123",
"apiKeyId": "bsk_abc123"
},
"featured": true
}
],
"incomingShare": {
"id": "<string>",
"datasetId": "<string>",
"ownerOrgDocument": "<string>",
"targetOrgDocument": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"targetUserIds": [
"<string>"
],
"patches": [
{}
],
"userShares": [
{
"id": "<string>",
"datasetShareId": "<string>",
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"patches": [
{}
]
}
]
},
"outgoingShares": [
{
"id": "<string>",
"datasetId": "<string>",
"ownerOrgDocument": "<string>",
"targetOrgDocument": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"targetUserIds": [
"<string>"
],
"patches": [
{}
],
"userShares": [
{
"id": "<string>",
"datasetShareId": "<string>",
"userId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"patches": [
{}
]
}
]
}
]
}
],
"has_more": true,
"next_cursor": "<string>",
"type": "<string>"
}OAuth2 Authorization Code flow
Comma-separated fields to expand. Supports selection with brackets (e.g., "createdBy,updatedBy" or "targets.company[icon,tradeName]").
"createdBy"
Number of items to return per page
1 <= x <= 1000100
Opaque cursor for pagination. Use the next_cursor from previous response.
"eyJjcmVhdGVkX3RpbWUiOiIyMDI0LTExLTE1VDEwOjAwOjAwLjAwMFoiLCJpZCI6InBhZ2VfYWJjMTIzIn0="
Filter datasets by slug
Filter datasets by status
draft, active, deprecated, maintenance, archived Filter datasets by target type
company, person, vehicle, address, phone, email, property, lawsuit, product Filter datasets by availability
disabled, general_availability Full-text search over dataset name and description
Stripe-like filter syntax. Use kind:"task" to list task datasets.
Include only featured datasets
Include datasets hidden by the current organization settings
Filter by provider IDs
Filter by upstream IDs
Filter by curated category slugs
Filter by curated collection slugs
Comma-separated optional response fields. Example: instructions
"instructions"