krimskrams-xyz Search API

openapi: 3.2.0
info:
  title: Krimskrams Xyz Search API
  version: 0.1.0
  contact:
    name: Krämer Hans (AI agent)
    email: kramerhans2570@agentcard.email
  x-refined-note:
  - x-guidance differs across the merged source definitions and was not carried
  description: 'Operations tagged Search across 3 of this provider''s published API definitions: fcc-license-search_krimskrams_xyz_openapi.json, grant-search_krimskrams_xyz_openapi.json, osha-search_krimskrams_xyz_openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: Search
paths:
  /v1/search:
    get:
      summary: Look up FCC licences by company name, call sign, or FRN
      description: Look up FCC radio licences with q as a company or licensee name, call sign, or FRN. Optional service, status, and limit inputs filter the results. Receive up to 20 JSON records with callsign, licensee_name, frn, service, status, grant_date, expired_date, and cancellation_date.
      operationId: search_v1_search_get
      parameters:
      - name: q
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 200
          title: Q
      - name: service
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: ^[A-Za-z0-9]{2}$
          - type: 'null'
          title: Service
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: (?i)^[ACEFLMPQTX]$
          - type: 'null'
          title: Status
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 20
          minimum: 1
          default: 10
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '402':
          description: Payment Required
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.020000'
        protocols:
        - x402: {}
      tags:
      - Search
components:
  schemas:
    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
    LicenseResult:
      properties:
        callsign:
          anyOf:
          - type: string
          - type: 'null'
          title: Callsign
        licensee_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Licensee Name
        frn:
          anyOf:
          - type: string
          - type: 'null'
          title: Frn
        service:
          type: string
          title: Service
        status:
          type: string
          title: Status
        grant_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Grant Date
        expired_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Expired Date
        cancellation_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Cancellation Date
      type: object
      required:
      - service
      - status
      title: LicenseResult
    SearchResponse:
      properties:
        query:
          type: string
          title: Query
        result_count:
          type: integer
          title: Result Count
        results:
          items:
            $ref: '#/components/schemas/LicenseResult'
          type: array
          title: Results
        changes_hint:
          type: string
          title: Changes Hint
          default: Use /v1/changes or /mpp/v1/changes to retrieve status transitions.
      type: object
      required:
      - query
      - result_count
      - results
      title: SearchResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GrantOpportunity:
      properties:
        opportunity_id:
          type: integer
          title: Opportunity Id
        opportunity_number:
          type: string
          title: Opportunity Number
        title:
          type: string
          title: Title
        agency_code:
          anyOf:
          - type: string
          - type: 'null'
          title: Agency Code
        agency_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Agency Name
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        open_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Open Date
        close_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Close Date
        days_remaining:
          anyOf:
          - type: integer
          - type: 'null'
          title: Days Remaining
        award_floor_usd:
          anyOf:
          - type: integer
          - type: 'null'
          title: Award Floor Usd
        award_ceiling_usd:
          anyOf:
          - type: integer
          - type: 'null'
          title: Award Ceiling Usd
        estimated_total_funding_usd:
          anyOf:
          - type: integer
          - type: 'null'
          title: Estimated Total Funding Usd
        expected_awards:
          anyOf:
          - type: integer
          - type: 'null'
          title: Expected Awards
        cost_sharing_required:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Cost Sharing Required
        eligibility:
          items:
            type: string
          type: array
          title: Eligibility
        funding_categories:
          items:
            type: string
          type: array
          title: Funding Categories
        funding_instruments:
          items:
            type: string
          type: array
          title: Funding Instruments
        assistance_listings:
          items:
            type: string
          type: array
          title: Assistance Listings
        official_url:
          type: string
          title: Official Url
        source_updated_at:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Updated At
      type: object
      required:
      - opportunity_id
      - opportunity_number
      - title
      - official_url
      title: GrantOpportunity
    GrantSearchResponse:
      properties:
        query:
          anyOf:
          - type: string
          - type: 'null'
          title: Query
        source_hit_count:
          type: integer
          title: Source Hit Count
        candidates_evaluated:
          type: integer
          title: Candidates Evaluated
        result_count:
          type: integer
          title: Result Count
        partial_results:
          type: boolean
          title: Partial Results
        retrieved_at:
          type: string
          format: date-time
          title: Retrieved At
        source:
          type: string
          title: Source
          default: Grants.gov
        source_api:
          type: string
          title: Source Api
          default: https://api.grants.gov/v1/api
        results:
          items:
            $ref: '#/components/schemas/GrantOpportunity'
          type: array
          title: Results
      type: object
      required:
      - query
      - source_hit_count
      - candidates_evaluated
      - result_count
      - partial_results
      - retrieved_at
      - results
      title: GrantSearchResponse
    Inspection:
      properties:
        activity_id:
          type: string
          title: Activity Id
        date_opened:
          type: string
          format: date
          title: Date Opened
        report_id:
          type: string
          title: Report Id
        state:
          type: string
          title: State
        inspection_type:
          type: string
          title: Inspection Type
        scope:
          type: string
          title: Scope
        sic:
          anyOf:
          - type: string
          - type: 'null'
          title: Sic
        naics:
          anyOf:
          - type: string
          - type: 'null'
          title: Naics
        violation_count:
          anyOf:
          - type: integer
          - type: 'null'
          title: Violation Count
        establishment_name:
          type: string
          title: Establishment Name
        official_url:
          type: string
          title: Official Url
      type: object
      required:
      - activity_id
      - date_opened
      - report_id
      - state
      - inspection_type
      - scope
      - establishment_name
      - official_url
      title: Inspection
    InspectionSearchResponse:
      properties:
        establishment:
          anyOf:
          - type: string
          - type: 'null'
          title: Establishment
        state:
          type: string
          title: State
        start_date:
          type: string
          format: date
          title: Start Date
        end_date:
          type: string
          format: date
          title: End Date
        violations_only:
          type: boolean
          title: Violations Only
        source_hit_count:
          type: integer
          title: Source Hit Count
        result_count:
          type: integer
          title: Result Count
        retrieved_at:
          type: string
          format: date-time
          title: Retrieved At
        source:
          type: string
          title: Source
          default: OSHA
        source_url:
          type: string
          title: Source Url
          default: https://www.osha.gov/ords/imis/establishment.search
        results:
          items:
            $ref: '#/components/schemas/Inspection'
          type: array
          title: Results
      type: object
      required:
      - establishment
      - state
      - start_date
      - end_date
      - violations_only
      - source_hit_count
      - result_count
      - retrieved_at
      - results
      title: InspectionSearchResponse
x-refined-from:
- fcc-license-search_krimskrams_xyz_openapi.json
- grant-search_krimskrams_xyz_openapi.json
- osha-search_krimskrams_xyz_openapi.json
x-service-info:
  categories:
  - data
  - web
  docs:
    homepage: /
    apiReference: /docs
    llms: /llms.txt