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

# Get search results

> Return normalized search results for standard modules and BYOK providers, along with breached and registered account outputs when available.



## OpenAPI

````yaml /api-reference/openapi.json get /search/{id}/results
openapi: 3.1.0
info:
  title: Osintly API
  version: 1.0.0
  description: OpenAPI specification for the Osintly API service.
  contact:
    name: Osintly
    url: https://docs.osint.ly/api-reference/quick-start
servers:
  - url: https://api.osint.ly
    description: Production
security: []
tags:
  - name: System
    description: Health and service checks
  - name: Auth
    description: Authorization validation
  - name: Search
    description: Create, monitor and retrieve search results
  - name: Usage
    description: Rate limit and usage information
  - name: Radar
    description: Breach intelligence endpoints (free with API key)
  - name: Webhooks
    description: Webhook callback payloads configured from search creation
paths:
  /search/{id}/results:
    get:
      tags:
        - Search
      summary: Get search results
      description: >-
        Return normalized search results for standard modules and BYOK
        providers, along with breached and registered account outputs when
        available.
      operationId: getSearchResults
      parameters:
        - $ref: '#/components/parameters/SearchId'
      responses:
        '200':
          description: Modules, breached accounts and registered accounts results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResultsResponse'
              examples:
                results:
                  value:
                    data:
                      modules:
                        - module:
                            id: null
                            name: GitHub
                          cards:
                            - github:
                                items:
                                  - label: Username
                                    value: target
                                    copy: true
                                    isdate: false
                                    islink: false
                      byok:
                        - provider: osint_industries
                          cards:
                            - byok_osint_industries:
                                items:
                                  - label: Domain
                                    value: example.com
                                    copy: true
                                    isdate: false
                                    islink: false
                                stats: []
                                additional: []
                                informations:
                                  title: Example
                      breached_accounts: []
                      registered_accounts: []
                    meta:
                      environment: production
                      timestamp: '2026-05-27T12:00:20.000Z'
        '400':
          $ref: '#/components/responses/SearchApiError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '500':
          $ref: '#/components/responses/SearchApiError'
      security:
        - bearerAuth: []
components:
  parameters:
    SearchId:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Search UUID
  schemas:
    SearchResultsResponse:
      type: object
      required:
        - data
        - meta
      properties:
        data:
          type: object
          required:
            - modules
            - byok
            - breached_accounts
            - registered_accounts
          properties:
            modules:
              type: array
              items:
                type: object
                required:
                  - module
                  - cards
                properties:
                  module:
                    type: object
                    required:
                      - id
                      - name
                    properties:
                      id:
                        type:
                          - string
                          - 'null'
                      name:
                        type: string
                  cards:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
            byok:
              type: array
              items:
                type: object
                required:
                  - provider
                  - cards
                properties:
                  provider:
                    type: string
                    enum:
                      - osint_industries
                      - sherlockeye
                  cards:
                    type: array
                    items:
                      type: object
                      additionalProperties: true
            breached_accounts:
              type: array
              items: {}
            registered_accounts:
              type: array
              items: {}
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    ResponseMeta:
      type: object
      required:
        - timestamp
      properties:
        environment:
          type: string
        timestamp:
          type: string
          format: date-time
    SearchApiErrorResponse:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
            details:
              oneOf:
                - type: string
                - type: array
                  items:
                    $ref: '#/components/schemas/ValidationIssue'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
    BasicErrorResponse:
      type: object
      required:
        - success
        - message
      properties:
        success:
          type: boolean
          enum:
            - false
        message:
          type: string
      additionalProperties: true
    ValidationIssue:
      type: object
      required:
        - path
        - message
      properties:
        path:
          type: string
        message:
          type: string
  responses:
    SearchApiError:
      description: Search API error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SearchApiErrorResponse'
          examples:
            validation_error:
              value:
                error:
                  code: VALIDATION_ERROR
                  message: Invalid request parameters
                  details:
                    - path: query.value
                      message: query.value must be a valid email
                meta:
                  timestamp: '2026-05-27T12:00:00.000Z'
            rate_limited:
              value:
                error:
                  code: RATE_LIMIT_EXCEEDED
                  message: Rate limit exceeded
                  details: API usage limits have been reached
                meta:
                  environment: production
                  timestamp: '2026-05-27T12:00:00.000Z'
            run_not_found:
              value:
                error:
                  code: RUN_NOT_FOUND
                  message: Search run not available
                  details: No active run is associated with this search
                meta:
                  environment: production
                  timestamp: '2026-05-27T12:00:00.000Z'
            leak_source_not_found:
              value:
                error:
                  code: LEAK_SOURCE_NOT_FOUND
                  message: Leak source not found
                  details: No leaked results source matches 'unknown-source'
                meta:
                  environment: production
                  timestamp: '2026-05-27T12:00:00.000Z'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BasicErrorResponse'
          examples:
            unauthorized:
              value:
                success: false
                message: Unauthorized
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````