/extractAPI keyYour extracts
Operation ID list_extract_extract_get
Parameters
query
- state"queued" | "running" | "succeeded" | "failed"[]
- No description.
- cursorstring | null
- From a previous page's
page.next_cursor. - sizeinteger | null
- Default 25.
Responses
- 200
- Listing_Extract_
- Successful Response
- 401
- Problem
credential_missing,credential_invalidorcredential_expired: send a live API key asAuthorization: Bearer <key>.- 402
- Problem
quota_exhausted: out of credits. Add credits, then send the request again.- 403
- Problem
entitlement_missing: your plan doesn't include this operation.- 404
- Problem
no_such_resource: no record has that id.- 422
- Problem
- The request can't be answered as sent. The code says why.
- 429
- Problem
rate_limited: wait forRetry-After, then retry.- 501
- Problem
not_available: this operation doesn't answer yet.
Example request
curl -X GET 'https://api.placestack.com/extract?state=NC&size=50' \
-H 'Authorization: Bearer $PLACESTACK_API_KEY'Example response
{
"request": {
"path": "<Path>",
"param": {},
"dry_run": false
},
"meta": {
"contract_date": "2026-09-13",
"vocabulary_version": "<Vocabulary Version>",
"request_id": "req_01h455vb4pex5vsknk084sn02q",
"api_version": "v1",
"answer_id": "ans_01h455vb4pex5vsknk084sn02q",
"answer_through": 1,
"unit": {
"key": "string"
},
"cost": "<Cost>"
},
"item": [
{
"id": "ext_01h455vb4pex5vsknk084sn02q",
"state": "queued",
"resource": "<Resource>",
"format": "jsonl",
"derived": true,
"created_at": "2026-09-13T12:00:00Z",
"href": "<Href>",
"row_estimate": 1,
"credit_estimate": 1,
"file": [
"<ExtractFile>"
],
"expires_at": "2026-09-13T12:00:00Z"
}
],
"page": {
"size": 1,
"next_cursor": "string",
"indeterminate": 0,
"total": "<envelope__Total>"
},
"as_of": {
"resolved": "<Interval>",
"timezone": "<Timezone>",
"basis": "requested",
"known_as_of": "2026-09-13T12:00:00Z",
"known_as_of_basis": "requested",
"requested": "string",
"earliest_retained": {
"key": "2026-09-13"
},
"constant": true,
"segment_count": 1
},
"notice": [
{
"code": "as_of_interval_spans_change",
"level": "info",
"detail": "<Detail>",
"count": 1,
"subject": [
"string"
]
}
]
}