> ## 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.

# Radar Details

> Get detailed Radar breach information by breach name. Free plan endpoint that requires an API key.



## OpenAPI

````yaml GET /radar/breaches/{name}
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:
  /radar/breaches/{name}:
    get:
      tags:
        - Radar
      summary: Get Radar details
      description: >-
        Return one breach record by its exact breach name. Radar is available on
        the Free plan and requires a bearer API key.
      operationId: getRadarBreachByName
      parameters:
        - $ref: '#/components/parameters/RadarBreachName'
      responses:
        '200':
          description: Radar breach details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RadarBreachResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
        '403':
          $ref: '#/components/responses/PlanFeatureRequiredError'
        '404':
          description: Breach not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchApiErrorResponse'
              examples:
                not_found:
                  value:
                    error:
                      code: NOT_FOUND
                      message: Breach not found
                    meta:
                      timestamp: '2026-06-13T12:00:00.000Z'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth: []
components:
  parameters:
    RadarBreachName:
      name: name
      in: path
      required: true
      schema:
        type: string
        minLength: 1
      description: Exact breach name (URL-encoded)
  schemas:
    RadarBreachResponse:
      type: object
      required:
        - breach
      properties:
        breach:
          $ref: '#/components/schemas/RadarBreach'
    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'
    RadarBreach:
      type: object
      required:
        - id
        - name
        - title
        - domain
        - breachDate
        - addedDate
        - modifiedDate
        - pwnCount
        - description
        - shortDescription
        - severity
        - dataClasses
        - isVerified
        - isFabricated
        - isSensitive
        - isRetired
        - isSpamList
        - isMalware
        - isSubscriptionFree
        - isStealerLog
        - logoPath
        - attribution
        - disclosureUrl
        - aiEnrichments
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        title:
          type: string
        domain:
          type: string
        breachDate:
          type: string
          format: date
        addedDate:
          type: string
          format: date
        modifiedDate:
          type: string
          format: date
        pwnCount:
          type: integer
        description:
          type: string
        shortDescription:
          type:
            - string
            - 'null'
        severity:
          $ref: '#/components/schemas/RadarSeverity'
        dataClasses:
          type: array
          items:
            type: string
        isVerified:
          type: boolean
        isFabricated:
          type: boolean
        isSensitive:
          type: boolean
        isRetired:
          type: boolean
        isSpamList:
          type: boolean
        isMalware:
          type: boolean
        isSubscriptionFree:
          type: boolean
        isStealerLog:
          type: boolean
        logoPath:
          type:
            - string
            - 'null'
        attribution:
          type:
            - string
            - 'null'
        disclosureUrl:
          type:
            - string
            - 'null'
        aiEnrichments:
          oneOf:
            - type: 'null'
            - type: object
              additionalProperties: true
    ValidationErrorResponse:
      type: object
      required:
        - error
        - meta
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              enum:
                - VALIDATION_ERROR
            message:
              type: string
              enum:
                - Invalid request parameters
            details:
              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
    ResponseMeta:
      type: object
      required:
        - timestamp
      properties:
        environment:
          type: string
        timestamp:
          type: string
          format: date-time
    InternalErrorResponse:
      allOf:
        - $ref: '#/components/schemas/BasicErrorResponse'
        - type: object
          properties:
            message:
              type: string
              enum:
                - Internal server error
    RadarSeverity:
      type: string
      enum:
        - critical
        - high
        - medium
  responses:
    ValidationError:
      description: Request validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ValidationErrorResponse'
    UnauthorizedError:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/BasicErrorResponse'
          examples:
            unauthorized:
              value:
                success: false
                message: Unauthorized
    PlanFeatureRequiredError:
      description: Plan feature required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SearchApiErrorResponse'
          examples:
            radar_feature_missing:
              value:
                error:
                  code: PLAN_FEATURE_REQUIRED
                  message: Plan feature required
                  details: Your plan does not include the radar feature
                meta:
                  timestamp: '2026-06-23T12:00:00.000Z'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key

````