Reference - Sandbox APIs
Endpoints
URLs for our Sandbox APIs follow this structure: https://sandbox.api.peopledatalabs.com/<path>
, where <path>
is one of the following:
API | Sandbox Endpoint Path |
---|---|
Person Enrichment | v5/person/enrich |
Person Search | v5/person/search |
Person Identify | v5/person/identify |
Bulk Person Enrichment API | v5/bulk/person |
Company Enrichment | v5/company/enrich |
Company Search | v5/company/search |
For example, the endpoint for the Sandbox Person Enrichment API is https://sandbox.api.peopledatalabs.com/v5/person/enrich
.
SDK Usage
To access the Sandbox API endpoints within our SDKs, use any of the following language-specific strategies:
# Set sandbox to True when creating a client
CLIENT = PDLPY(
api_key="YOUR API KEY",
# Use Sandbox API
sandbox=True,
)
// Set sandbox to true in the parameters JSON object
const params = {
email: "[email protected]",
min_likelihood: 6,
// Use Sandbox API
sandbox: true
}
# Use Sandbox API
Peopledatalabs.sandbox = true
// Include extra imports
import (
pdl "github.com/peopledatalabs/peopledatalabs-go"
"github.com/peopledatalabs/peopledatalabs-go/api"
pdlmodel "github.com/peopledatalabs/peopledatalabs-go/model"
)
// Set Sandbox to true in ClientOptions() when creating a client
client := pdl.New(apiKey,
api.ClientOptions(func(c *api.Client) {
c.Sandbox = true
}))
See Sandbox examples for specific usage.
Billing and Access
The Sandbox APIs are free endpoints and do not consume credits. All plans have access.
Rate Limiting
The default rate limit for all customers is five calls per minute.
Input Parameters
The input parameters for each Sandbox API endpoint are identical to the input parameters for the corresponding production endpoint. Here are the input parameters that each Sandbox endpoint supports:
Sandbox API Endpoint | Input Parameters | Detailed Reference |
---|---|---|
Person Enrichment | Input Parameters | Detailed Reference |
Person Search | Input Parameters | Detailed Reference |
Person Identify | Input Parameters | Detailed Reference |
Bulk Person Enrichment | Input Parameters | Detailed Reference |
Company Enrichment | Input Parameters | Detailed Reference |
Company Search | Input Parameters | Detailed Reference |
Output Response
All Sandbox API endpoints return data that follows the same response structure as the corresponding production endpoint. Here are the output responses that each Sandbox endpoint supports:
Synthetic data only!
All Sandbox API endpoints return only artificial data in their responses. For more information, see the Full Sandbox Datasets listed below.
Sandbox API Endpoint | Output Response | Detailed Reference |
---|---|---|
Person Enrichment | Output Response | Detailed Reference |
Person Search | Output Response | Detailed Reference |
Person Identify | Output Response | Detailed Reference |
Bulk Person Enrichment | Output Response | Detailed Reference |
Company Enrichment | Output Response | Detailed Reference |
Company Search | Output Response | Detailed Reference |
Sandbox Dataset
All Sandbox API endpoints return data that is artificial with no intended real-world value.
You can download the full dataset of the synthetic records that the Sandbox API uses here:
Full Sandbox Datasets |
---|
Person Sandbox Dataset |
Company Sandbox Dataset |
Updated as of 28.0
Updated 5 days ago