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

# Search Breach Records with JSON Filter

> Same response and flat query parameters as `GET /service/v2/breach/search`,
but sends `filter` or `filter_id` in a JSON body.

Use POST for the same flows as the web app: AI filters, advanced manual
filters, saved filter contexts, or long filter trees. Keep regular search
controls such as `q`, `cursor`, `page_size`, `sort`, `from`, `to`, and
`search_id` in the query string.

Supports the same basic, flat, alias, and autocomplete-backed breach
filter fields documented on `GET /service/v2/breach/search`.




## OpenAPI

````yaml /openapi.yaml post /service/v2/breach/search
openapi: 3.1.0
info:
  title: OathNet Service API
  version: 2.0.0
  description: >
    # OathNet Service API Documentation


    Welcome to the OathNet Service API. This API provides breach search, stealer
    search,

    victims exploration, file search, exports, bulk search, scanners, and OSINT
    enrichment.


    ## Authentication


    Most `/api/service/*` endpoints require authentication via API key. Include
    your API key

    in the `x-api-key` header.


    ```

    x-api-key: YOUR_API_KEY

    ```


    You can obtain an API key from your dashboard at
    https://oathnet.org/dashboard?tab=account


    ## Rate Limiting & Quotas


    - Each request consumes from your daily lookup quota

    - Quota limits depend on your subscription plan

    - The `_meta.lookups` object in responses shows remaining daily lookups

    - Service-specific quotas may apply to certain endpoints


    ## Search Sessions


    For optimal quota management, initialize a search session before making
    service calls:

    1. Call `/service/search/init` with your query

    2. Use the returned `session.id` as `search_id` in subsequent service calls

    3. This groups related lookups and provides better quota tracking


    ## Structured Filters


    V2 search endpoints share one structured filter contract:


    - use `GET` for simple searches and URL-friendly flat filters

    - use `POST` on the same search route when you have an AI/manual structured
    filter, a saved `filter_id`, or a filter tree that is awkward to URL-encode

    - `filter` is a JSON-encoded filter tree on query-string endpoints and a
    real JSON object on POST endpoints

    - POST search routes still take pagination, sorting, date range, `view`, and
    `search_id` as query parameters; the JSON body is for `filter` and
    `filter_id`

    - `filter_id` is a 24-character transient context ID returned by the AI
    filter flow or prior searches

    - explicit `filter` overrides a stored `filter_id` context, and flat params
    may still be used in the same request

    - the same filter objects are reused by AI filter responses, exports, bulk
    search, and scanners

    - advanced filters use leaf rules with `field`, `operator`, and `value`,
    plus `and` / `or` groups for boolean logic

    - supported operators are `eq`, `neq`, `contains`, `starts_with`,
    `ends_with`, `wildcard`, `gt`, `gte`, `lt`, `lte`, `exists`, `in`, and
    `not_in`


    See the `StructuredFilterNode` schema and `/guides/structured-filters` for
    the full operator list and examples.


    ## Success Response Patterns


    Successful responses use three main patterns:


    - Envelope JSON:
      Common on search-session and OSINT endpoints, plus `v2/stealer/search`,
      `v2/breach/search`, `v2/victims/search`, `v2/stealer/subdomain`,
      and `v2/bulk-search` create.
    - Raw JSON:
      Common on `v2/breach/autocomplete*`, `v2/ai/filter*`,
      `v2/files/search`, `v2/victims/*/properties`, `v2/victims/*/summary`,
      `v2/file-search*`, `v2/exports*`, `v2/bulk-search` list and status,
      `v2/victims/{log_id}`, `v2/phonebook`, and most scanner endpoints.
    - File or text stream:
      Victim file downloads, victim archive downloads, export downloads,
      and bulk-search downloads.

    ## Error Handling


    API-generated errors generally return with `success: false` and include:

    - `message`: Human-readable error description

    - `errors`: Object with field-specific or general error details


    Common HTTP status codes:

    - `200`: Success

    - `202`: Async job accepted

    - `400`: Bad Request (invalid parameters)

    - `401`: Unauthorized (missing or invalid token)

    - `403`: Forbidden (Cloudflare block or quota exceeded)

    - `404`: Not Found

    - `409`: Conflict

    - `429`: Too Many Requests

    - `500`: Internal Server Error

    - `502`: Bad Gateway

    - `503`: Service Unavailable
  contact:
    name: OathNet Support
    url: https://oathnet.org/support
  license:
    name: Proprietary
    url: https://oathnet.org/terms
servers:
  - url: https://oathnet.org/api
    description: Production API Server
security:
  - ApiKeyAuth: []
tags:
  - name: Search Session
    description: Initialize and manage search sessions for grouped lookups
  - name: Breach Search
    description: Search across breach databases for leaked credentials and data
  - name: Stealer Search
    description: Original stealer search route for simple credential lookups
  - name: V2 Stealer
    description: Enhanced V2 stealer search with advanced filtering and pagination
  - name: V2 Investigation
    description: >-
      Multi-section investigation across credentials, victims, evidence, files,
      and related credentials
  - name: V2 Breach
    description: Current breach search, autocomplete, and filter workflows
  - name: V2 Victims
    description: Search and explore victim profiles and their associated files
  - name: V2 File Search
    description: Search within victim files using regex, literal, or wildcard patterns
  - name: V2 File Metadata
    description: Search victim file metadata without fetching file bytes
  - name: V2 Export
    description: Export search results to JSONL or CSV format
  - name: V2 Bulk Search
    description: Batch many terms into an asynchronous export-style search job
  - name: Scanners
    description: >-
      Automated monitoring and delivery management for stealer and breach
      scanners
  - name: OSINT Lookups
    description: Open Source Intelligence lookups for various platforms
  - name: Utility
    description: Utility endpoints for autocomplete and other helpers
paths:
  /service/v2/breach/search:
    post:
      tags:
        - V2 Breach
      summary: Search Breach Records with JSON Filter
      description: >
        Same response and flat query parameters as `GET
        /service/v2/breach/search`,

        but sends `filter` or `filter_id` in a JSON body.


        Use POST for the same flows as the web app: AI filters, advanced manual

        filters, saved filter contexts, or long filter trees. Keep regular
        search

        controls such as `q`, `cursor`, `page_size`, `sort`, `from`, `to`, and

        `search_id` in the query string.


        Supports the same basic, flat, alias, and autocomplete-backed breach

        filter fields documented on `GET /service/v2/breach/search`.
      operationId: searchBreachV2Post
      parameters:
        - $ref: '#/components/parameters/CursorParam'
        - $ref: '#/components/parameters/PageSizeParam'
        - $ref: '#/components/parameters/SortParam'
        - $ref: '#/components/parameters/FromParam'
        - $ref: '#/components/parameters/ToParam'
        - $ref: '#/components/parameters/DateFieldParam'
        - $ref: '#/components/parameters/FieldsParam'
        - $ref: '#/components/parameters/SearchIdParam'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/V2SearchPostBody'
            examples:
              inline_filter:
                summary: Inline structured filter
                value:
                  filter:
                    and:
                      - field: email_domain
                        operator: eq
                        value: example.com
                      - field: country
                        operator: in
                        value:
                          - US
                          - CA
              saved_filter_context:
                summary: Reuse a saved AI/manual filter context
                value:
                  filter_id: 0123456789abcdef01234567
      responses:
        '200':
          description: Breach search response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V2BreachSearchResponse'
components:
  parameters:
    CursorParam:
      name: cursor
      in: query
      description: Cursor token from the previous response's `next_cursor`.
      schema:
        type: string
    PageSizeParam:
      name: page_size
      in: query
      description: Number of results to return.
      schema:
        type: integer
        minimum: 1
        maximum: 200
    SortParam:
      name: sort
      in: query
      schema:
        type: string
    FromParam:
      name: from
      in: query
      schema:
        type: string
        format: date-time
    ToParam:
      name: to
      in: query
      schema:
        type: string
        format: date-time
    DateFieldParam:
      name: date_field
      in: query
      schema:
        type: string
        enum:
          - indexed_at
          - pwned_at
    FieldsParam:
      name: fields[]
      in: query
      description: Response field whitelist.
      schema:
        type: array
        items:
          type: string
      style: form
      explode: true
    SearchIdParam:
      name: search_id
      in: query
      description: Search session ID from `POST /service/search/init`.
      schema:
        type: string
  schemas:
    V2SearchPostBody:
      type: object
      description: |
        JSON body used by POST variants of V2 search endpoints.

        Use this body when the request has an AI/manual structured filter or an
        existing filter context ID. Regular controls such as `q`, `cursor`,
        `page_size`, `sort`, date range, `view`, and `search_id` stay in the
        query string so GET and POST responses remain identical.
      properties:
        filter:
          allOf:
            - $ref: '#/components/schemas/StructuredFilterNode'
          description: >
            Inline structured filter tree. The tree can contain leaf rules with

            `field`, `operator`, and `value`, or compound `and` / `or` groups.

            When both `filter` and `filter_id` are sent, the inline filter is
            the

            explicit filter for this request.
        filter_id:
          allOf:
            - $ref: '#/components/schemas/FilterContextId'
          description: |
            Transient filter context ID returned by `POST /service/v2/ai/filter`
            or by a previous V2 search response. Use it to run the same saved
            filter without resending the full filter tree.
      additionalProperties: true
    V2BreachSearchResponse:
      type: object
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          $ref: '#/components/schemas/V2BreachSearchData'
    StructuredFilterNode:
      description: |
        Recursive structured filter tree.

        Constraints:
        - maximum nesting depth: 2
        - maximum leaf conditions: 50
        - each node should use exactly one of `field`, `and`, or `or`
      oneOf:
        - $ref: '#/components/schemas/StructuredFilterLeafNode'
        - $ref: '#/components/schemas/StructuredFilterAndNode'
        - $ref: '#/components/schemas/StructuredFilterOrNode'
    FilterContextId:
      type: string
      description: 24-character transient filter context ID.
      pattern: ^[0-9a-fA-F]{24}$
      example: 0123456789abcdef01234567
    V2BreachSearchData:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/V2BreachResult'
        meta:
          $ref: '#/components/schemas/V2SearchMetadata'
        dbname_info:
          type: object
          description: Public metadata keyed by breach `dbname`.
          additionalProperties:
            $ref: '#/components/schemas/V2LeakMetadata'
        next_cursor:
          type: string
        _meta:
          type: object
          additionalProperties: true
    StructuredFilterLeafNode:
      type: object
      description: Leaf rule for one field.
      required:
        - field
        - operator
      properties:
        field:
          type: string
          description: Public field name accepted by the selected endpoint.
          example: country
        operator:
          $ref: '#/components/schemas/FilterOperator'
        value:
          $ref: '#/components/schemas/StructuredFilterValue'
      example:
        field: country
        operator: eq
        value: us
    StructuredFilterAndNode:
      type: object
      description: Compound node that ANDs all child rules.
      required:
        - and
      properties:
        and:
          type: array
          items:
            $ref: '#/components/schemas/StructuredFilterNode'
      example:
        and:
          - field: country
            operator: eq
            value: us
          - field: dbname
            operator: eq
            value: linkedin.com
    StructuredFilterOrNode:
      type: object
      description: Compound node that ORs all child rules.
      required:
        - or
      properties:
        or:
          type: array
          items:
            $ref: '#/components/schemas/StructuredFilterNode'
      example:
        or:
          - field: email
            operator: ends_with
            value: '@gmail.com'
          - field: email
            operator: ends_with
            value: '@outlook.com'
    V2BreachResult:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        email_domain:
          type: string
        username:
          type: string
        password:
          type: string
        password_hash:
          type: string
        salt:
          type: string
        full_name:
          type: string
        first_name:
          type: string
        last_name:
          type: string
        middle_name:
          type: string
        display_name:
          type: string
        phone_number:
          type: string
        phone_national:
          type: string
        address_street:
          type: string
        city:
          type: string
        state:
          type: string
        postal_code:
          type: string
        country:
          type: string
        date_birth:
          type: string
        age:
          type: integer
        created_at:
          type: string
        last_login:
          type: string
        indexed_at:
          type: string
          format: date-time
        ip:
          type: string
        discordid:
          type: string
        instagram:
          type: string
        linkedin:
          type: string
        iban:
          type: string
        ssn:
          type: string
        dbname:
          type: string
        gender:
          type: string
        language:
          type: string
        bio:
          type: string
        location:
          type: string
        extra:
          type: object
          additionalProperties: true
    V2SearchMetadata:
      type: object
      properties:
        count:
          type: integer
          description: Results in this page
        total:
          type: integer
          description: Total matching results
        took_ms:
          type: integer
          description: Query time in milliseconds
        has_more:
          type: boolean
        total_pages:
          type: integer
        max_score:
          type: number
        filter_id:
          $ref: '#/components/schemas/FilterContextId'
    V2LeakMetadata:
      type: object
      properties:
        Title:
          type: string
        Domain:
          type: string
        BreachDate:
          type: string
        PwnCount:
          type: integer
        Description:
          type: string
    FilterOperator:
      type: string
      description: |
        Structured filter operator.

        `in` and `not_in` require string arrays.
        `exists` accepts a boolean and defaults to `true` when omitted.
        All other operators expect string values.
      enum:
        - eq
        - neq
        - in
        - not_in
        - contains
        - starts_with
        - ends_with
        - gt
        - gte
        - lt
        - lte
        - exists
        - wildcard
    StructuredFilterValue:
      description: |
        Filter value payload.

        Use strings for most operators, string arrays for `in` and `not_in`,
        and booleans for `exists`.
      oneOf:
        - type: string
        - type: boolean
        - type: array
          items:
            type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication (lowercase header name)

````