> ## Documentation Index
> Fetch the complete documentation index at: https://vpn-docs.wxapros.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Export dataset listing

> Download links and checksums for every bulk file your plan includes.



## OpenAPI

````yaml GET /api/v1/export/dataset
openapi: 3.1.0
info:
  title: VPN & Proxy Detection API
  description: >-
    Lookup and bulk IP intelligence for VPN, proxy, Tor, relay, hosting, CDN,
    and residential proxy detection.


    **Authentication:** every endpoint in this reference requires your API key.
    https://vpn-docs.wxapros.com/authentication describes how to pass it.


    **Tiers:** Intro, Starter, Pro, Scale, Business, Enterprise. Pro+ adds
    residential proxy attribution, confidence/freshness, and CSV export.
    Business+ adds MMDB and Parquet bulk downloads. Enterprise adds NetFlow
    protocol attribution.
  contact:
    name: WXA VPN Support
    url: https://www.whoisxmlapi.com/
    email: service.desk@whoisxmlapi.com
  version: 1.0.0
servers:
  - url: https://vpn-proxy-detection.whoisxmlapi.com
    description: The public API. Every path in this reference starts with /api/v1.
security:
  - apiKey: []
paths:
  /api/v1/export/dataset:
    get:
      summary: Export dataset listing
      description: >-
        Download links, with checksums, for every file of the current daily
        build that your plan includes, plus the build's README.md and
        manifest.json. Pro and Scale get the network-range table as CSV,
        zstd-compressed CSV and NDJSON. Business and Enterprise also get
        Parquet, the two MMDB files and the residential /32 points files, the
        1-, 7-, 30- and 90-day windows included. The links expire after an hour:
        call again for new ones.


        Available to Pro+ tiers.
      operationId: export_dataset_api_v1_export_dataset_get
      parameters:
        - name: format
          in: query
          required: false
          description: >-
            List one format only: csv, csv-zstd, ndjson, parquet or mmdb. The
            default, all, lists every format your plan includes. A format your
            plan does not include gets 403.
          schema:
            type: string
            enum:
              - all
              - csv
              - csv-zstd
              - ndjson
              - parquet
              - mmdb
            default: all
            title: Format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                title: DatasetListing
                properties:
                  build:
                    type:
                      - string
                      - 'null'
                    description: The build's version, from its manifest.
                  generated_at:
                    type:
                      - string
                      - 'null'
                    description: When the build was generated, in ISO 8601.
                  record_counts:
                    type: object
                    additionalProperties:
                      type: integer
                    description: >-
                      Rows in each of the build's two tables, the network-range
                      table and the residential points, keyed by the tables' own
                      names (not the ranges and points values of a file's
                      table). The window files have no entry of their own.
                  files:
                    type: array
                    items:
                      type: object
                      properties:
                        filename:
                          type: string
                          description: The file's name.
                        format:
                          type: string
                          enum:
                            - csv
                            - csv-zstd
                            - ndjson
                            - parquet
                            - mmdb
                          description: The file's format.
                        table:
                          type:
                            - string
                            - 'null'
                          description: >-
                            What the file holds: ranges (the network-range
                            table), points (every residential /32 point) or a
                            points window (points_1d, points_7d, points_30d or
                            points_90d).
                        record_count:
                          type:
                            - integer
                            - 'null'
                          description: Rows in the file.
                        size_bytes:
                          type:
                            - integer
                            - 'null'
                          description: The file's size, in bytes.
                        sha256:
                          type:
                            - string
                            - 'null'
                          description: >-
                            SHA-256 of the file as stored. When it is null,
                            check sha256_uncompressed where it is present, or
                            the row count.
                        sha256_uncompressed:
                          type: string
                          description: >-
                            SHA-256 of the file's decompressed contents. Present
                            only for formats that have one.
                        download_url:
                          type: string
                          description: >-
                            A signed download link, valid for
                            expires_in_seconds.
                      required:
                        - filename
                        - format
                        - table
                        - record_count
                        - size_bytes
                        - sha256
                        - download_url
                    description: >-
                      The files your plan includes, narrowed by format when you
                      pass one.
                  readme_url:
                    type:
                      - string
                      - 'null'
                    description: A signed link to the build's README.md.
                  manifest_url:
                    type:
                      - string
                      - 'null'
                    description: >-
                      A signed link to the build's manifest.json, which lists
                      every file of the build with its checksum.
                  expires_in_seconds:
                    type: integer
                    const: 3600
                    description: 'How long the links last: always 3600 seconds.'
                required:
                  - build
                  - generated_at
                  - record_counts
                  - files
                  - readme_url
                  - manifest_url
                  - expires_in_seconds
        '403':
          description: >-
            The format you asked for is not in your plan, or your plan is below
            Pro
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '503':
          description: >-
            Either no build is available to list right now (contact
            service.desk@whoisxmlapi.com), or, with error code
            `copies_preparing` and a `Retry-After` header, your copies of a new
            build are still being prepared: call again after that many seconds
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: apiKey
      description: >-
        Your API key, passed as the apiKey query parameter on every request. A
        key sent in a header (Authorization or X-API-Key) is not accepted and
        gets 401.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.