Bright Data

Bright Data Snapshots API

The Snapshots API from Bright Data — 6 operation(s) for snapshots.

GitHub OpenAPI

Operations 6

GET /datasets/snapshots/{snapshot_id} Get Dataset Snapshot #
GET /datasets/v3/log/{snapshot_id} Get Snapshot Log #
GET /datasets/v3/snapshots List Snapshots #
POST /datasets/v3/snapshot/{snapshot_id}/cancel Cancel a Snapshot #
POST /datasets/v3/snapshot/{snapshot_id}/rerun Rerun a Snapshot #
GET /datasets/v3/snapshot/{snapshot_id} Download Snapshot Results #

Documentation

📖
Documentation
https://docs.brightdata.com/scraping-automation/web-unlocker/introduction
📖
Documentation
https://docs.brightdata.com/scraping-automation/web-unlocker/async-requests
📖
Documentation
https://docs.brightdata.com/scraping-automation/web-scraper-api/overview
📖
Documentation
https://docs.brightdata.com/scraping-automation/web-scraper-api/trigger-a-collection
📖
Documentation
https://docs.brightdata.com/scraping-automation/scraping-browser/introduction
📖
Documentation
https://docs.brightdata.com/scraping-automation/scraping-browser/quickstart
📖
Documentation
https://docs.brightdata.com/api-reference/deep-lookup/Deep-Lookup-API-Overview
📖
Documentation
https://docs.brightdata.com/api-reference/web-archive-api/Web-Archive-API-Overview
📖
Documentation
https://docs.brightdata.com/datasets/marketplace
📖
Documentation
https://docs.brightdata.com/api-reference/account-management-api/Account-Management-API-Overview
📖
Documentation
https://docs.brightdata.com/proxy-networks/proxy-manager/api
📖
Documentation
https://docs.brightdata.com/api-reference/scraping-shield-api/Scraping-Shield-API-Overview

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bright-data/refs/heads/main/openapi/bright-data-snapshots-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bright-data/refs/heads/main/json-schema/bright-data-snapshot-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/bright-data/refs/heads/main/json-schema/bright-data-zone-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bright-data-snapshots-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bright-data-snapshots-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Bright Data Snapshots API
  version: v3
  contact:
    name: Bright Data
    url: https://docs.brightdata.com
  description: 'Operations tagged Snapshots across 2 of this provider''s published API definitions: bright-data-dataset-marketplace-api-openapi.yml, bright-data-web-scraper-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.brightdata.com
  description: Production
security:
- BearerAuth: []
tags:
- name: Snapshots
paths:
  /datasets/snapshots/{snapshot_id}:
    parameters:
    - name: snapshot_id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get Dataset Snapshot
      operationId: getDatasetSnapshot
      tags:
      - Snapshots
      parameters:
      - name: format
        in: query
        schema:
          type: string
          enum:
          - json
          - ndjson
          - csv
          - parquet
      responses:
        '200':
          description: Snapshot rows.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  additionalProperties: true
    servers:
    - url: https://api.brightdata.com
      description: Production
  /datasets/v3/log/{snapshot_id}:
    parameters:
    - name: snapshot_id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Get Snapshot Log
      operationId: getSnapshotLog
      tags:
      - Snapshots
      responses:
        '200':
          description: Snapshot log.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
    servers:
    - url: https://api.brightdata.com
      description: Production
  /datasets/v3/snapshots:
    get:
      summary: List Snapshots
      operationId: listSnapshots
      tags:
      - Snapshots
      parameters:
      - name: dataset_id
        in: query
        schema:
          type: string
      - name: from_date
        in: query
        schema:
          type: string
          format: date
      - name: to_date
        in: query
        schema:
          type: string
          format: date
      - name: status
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Snapshots.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Snapshot'
    servers:
    - url: https://api.brightdata.com
      description: Production
  /datasets/v3/snapshot/{snapshot_id}/cancel:
    parameters:
    - name: snapshot_id
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Cancel a Snapshot
      operationId: cancelSnapshot
      tags:
      - Snapshots
      responses:
        '200':
          description: Cancelled.
          content:
            application/json:
              schema:
                type: object
    servers:
    - url: https://api.brightdata.com
      description: Production
  /datasets/v3/snapshot/{snapshot_id}/rerun:
    parameters:
    - name: snapshot_id
      in: path
      required: true
      schema:
        type: string
    post:
      summary: Rerun a Snapshot
      operationId: rerunSnapshot
      tags:
      - Snapshots
      responses:
        '200':
          description: Snapshot rerun started.
          content:
            application/json:
              schema:
                type: object
                properties:
                  snapshot_id:
                    type: string
    servers:
    - url: https://api.brightdata.com
      description: Production
  /datasets/v3/snapshot/{snapshot_id}:
    parameters:
    - name: snapshot_id
      in: path
      required: true
      schema:
        type: string
    get:
      summary: Download Snapshot Results
      operationId: downloadSnapshot
      tags:
      - Snapshots
      parameters:
      - name: format
        in: query
        schema:
          type: string
          enum:
          - json
          - ndjson
          - csv
          - jsonl
      - name: compress
        in: query
        schema:
          type: boolean
      - name: batch_size
        in: query
        schema:
          type: integer
      - name: part
        in: query
        schema:
          type: integer
      responses:
        '200':
          description: Snapshot data (up to 5 GB per request).
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
            text/csv:
              schema:
                type: string
            application/x-ndjson:
              schema:
                type: string
    servers:
    - url: https://api.brightdata.com
      description: Production
components:
  schemas:
    Snapshot:
      type: object
      properties:
        id:
          type: string
        dataset_id:
          type: string
        status:
          type: string
        created:
          type: string
          format: date-time
        dataset_size:
          type: integer
        records:
          type: integer
        errors:
          type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
x-refined-from:
- bright-data-dataset-marketplace-api-openapi.yml
- bright-data-web-scraper-api-openapi.yml