Quickstart
Get started with WhereParcel API in 5 minutes
Get started with WhereParcel API in just a few minutes.
1. Get Your API Keys
Sign up, then get your API keys from the Dashboard. You can cancel anytime — you keep access until the end of your billing period.
2. Make Your First Request
curl -X POST https://api.whereparcel.com/v2/track \
-H "Authorization: Bearer YOUR_API_KEY:YOUR_SECRET_KEY" \
-H "Content-Type: application/json" \
-d '{
"trackingItems": [
{
"carrier": "us.usps",
"trackingNumber": "9400111899562537866361"
}
]
}'
3. Parse the Response
{
"success": true,
"data": [
{
"carrier": "us.usps",
"trackingNumber": "9400111899562537866361",
"status": "success",
"data": {
"deliveryStatus": "delivered",
"events": [
{
"timestamp": "2026-10-01T18:31:00.000Z",
"status": "delivered",
"location": "DECATUR, GA 30030",
"description": "Delivered, Front Door/Porch",
"rawStatus": "Delivered, Front Door/Porch",
"rawDescription": "Delivered, Front Door/Porch"
}
],
"lastUpdated": "2026-10-02T14:05:12.000Z"
},
"billable": true,
"cached": false
}
],
"summary": { "total": 1, "success": 1, "failed": 0, "usageIncremented": 1 }
}
data is an array with one result per tracking item. Check each item’s status (success or error) first, then read data.deliveryStatus — always one of nine values: pending, in_transit, out_for_delivery, delivered, failed, returned, cancelled, lost, unknown. The carrier’s own wording stays in rawStatus and rawDescription. Timestamps are UTC. Cache hits come back with billable: false.
Next Steps
- API Playground — Test the API interactively without writing code
- Authentication - Learn about API authentication
- API Reference - Explore all endpoints
- Carriers - View supported carriers