Historical.batch.list_jobs
Info
The response format of this endpoint was changed on 2026-09-29. Users can obtain the deprecated response format by specifying short=False until 2026-10-27. For information about this change, see this announcement.
List batch job details for the user account.
The job details will be sorted in order of ts_received.
To obtain the full details for a job, use batch.get_job_details, which returns the full set of fields for a single job.
Related: Download center.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
states | Iterable[JobState | str] or JobState or str | optional | The filter for job states as a list of comma separated values. Can include 'queued', 'processing', 'done', and 'expired'. Defaults to all except 'expired'. |
since | pd.Timestamp, datetime, date, str, or int | optional | The filter for timestamp submitted (will not include jobs prior to this). Takes pd.Timestamp, Python datetime, Python date, ISO 8601 string, or UNIX timestamp in nanoseconds. Assumes UTC as timezone unless otherwise specified. |
short | bool | optional | If False, return the deprecated long form response for each job, which includes all job fields reported by batch.get_job_details. Defaults to the short form. |
Returns
list[dict[str, Any]]
A list of batch job details.
| Field | Type | Description |
|---|---|---|
id | str | The unique job ID for the request. |
state | str | The current status of the batch job. One of 'received', 'queued', 'processing', 'done', or 'expired'. |
ts_received | str | The ISO 8601 timestamp when Databento received the batch job. |
API method
1 2 3 4 5
Historical.batch.list_jobs(
states: Iterable[JobState | str] | JobState | str | None = "queued,processing,done",
since: pd.Timestamp | datetime | date | str | int | None = None,
short: bool | None = None,
) -> list[dict[str, Any]] Example usage
1 2 3 4 5 6 7 8 9
import databento as db
client = db.Historical("$YOUR_API_KEY")
jobs = client.batch.list_jobs(
states=["queued", "processing", "done"],
since="2022-06-01",
)
print(jobs) Example response
1 2 3 4 5 6 7
[
{
"id": "GLBX-20221126-DBVXWPJJQN",
"state": "done",
"ts_received": "2022-11-26T09:23:17.519708000Z"
},
...