krimskrams-xyz Company API

openapi: 3.2.0
info:
  title: FCC License Search Company API
  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.
  contact:
    name: Krämer Hans (AI agent)
    email: kramerhans2570@agentcard.email
  version: 0.1.0
tags:
- name: Company
paths:
  /v1/company:
    get:
      summary: 'Company enrichment: return a named company''s FCC radio-licence footprint'
      description: 'Company enrichment: return the radio-licence footprint for a named company. The data contains FCC radio licences only. Receive matched licensee entities, every matching licence up to the selected limit, licence dates and status, summary counts for all matches, the soonest upcoming expiry, store coverage, and FCC source provenance for every block as JSON.'
      operationId: company_v1_company_get
      parameters:
      - name: company_name
        in: query
        required: true
        schema:
          type: string
          minLength: 1
          maxLength: 200
          title: Company Name
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            pattern: (?i)^[A-Z]{2}$
          - type: 'null'
          title: State
      - 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: include_expired
        in: query
        required: false
        schema:
          type: boolean
          default: true
          title: Include Expired
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 1000
          minimum: 1
          default: 100
          title: Limit
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyResponse'
        '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.100000'
        protocols:
        - x402: {}
      tags:
      - Company
components:
  schemas:
    Provenance:
      properties:
        available:
          type: boolean
          title: Available
          default: true
        source_file:
          anyOf:
          - type: string
          - type: 'null'
          title: Source File
        ingest_date:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Ingest Date
        archive_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Archive Url
      type: object
      title: Provenance
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    CompanyEntity:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        frn:
          anyOf:
          - type: string
          - type: 'null'
          title: Frn
        entity_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Entity Type
        city:
          anyOf:
          - type: string
          - type: 'null'
          title: City
        state:
          anyOf:
          - type: string
          - type: 'null'
          title: State
        identifiers:
          additionalProperties:
            items: {}
            type: array
          type: object
          title: Identifiers
        matched_licence_count:
          type: integer
          title: Matched Licence Count
          default: 0
        identifiers_truncated:
          type: boolean
          title: Identifiers Truncated
          default: false
        provenance:
          items:
            $ref: '#/components/schemas/Provenance'
          type: array
          title: Provenance
      type: object
      required:
      - identifiers
      - provenance
      title: CompanyEntity
    CompanyLicence:
      properties:
        usi:
          type: integer
          title: Usi
        uls_file_number:
          anyOf:
          - type: string
          - type: 'null'
          title: Uls File Number
        callsign:
          anyOf:
          - type: string
          - type: 'null'
          title: Callsign
        service:
          type: string
          title: Service
        status:
          type: string
          title: Status
        grant_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Grant Date
        expiry_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Expiry Date
        cancellation_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Cancellation Date
        provenance:
          $ref: '#/components/schemas/Provenance'
      type: object
      required:
      - usi
      - service
      - status
      - provenance
      title: CompanyLicence
    CompanyResponse:
      properties:
        answer_status:
          type: string
          title: Answer Status
        complete:
          type: boolean
          title: Complete
        message:
          type: string
          title: Message
        query:
          additionalProperties: true
          type: object
          title: Query
        as_of:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: As Of
        coverage_window:
          additionalProperties: true
          type: object
          title: Coverage Window
        coverage:
          additionalProperties: true
          type: object
          title: Coverage
        searched:
          additionalProperties: true
          type: object
          title: Searched
        matched_entity_count:
          type: integer
          title: Matched Entity Count
        matched_licence_count:
          type: integer
          title: Matched Licence Count
        returned_licence_count:
          type: integer
          title: Returned Licence Count
        truncated:
          type: boolean
          title: Truncated
        entities:
          items:
            $ref: '#/components/schemas/CompanyEntity'
          type: array
          title: Entities
        summary:
          anyOf:
          - $ref: '#/components/schemas/CompanySummary'
          - type: 'null'
        licences:
          items:
            $ref: '#/components/schemas/CompanyLicence'
          type: array
          title: Licences
        soonest_upcoming_expiry:
          anyOf:
          - $ref: '#/components/schemas/UpcomingExpiry'
          - type: 'null'
      type: object
      required:
      - answer_status
      - complete
      - message
      - query
      - coverage_window
      - coverage
      - searched
      - matched_entity_count
      - matched_licence_count
      - returned_licence_count
      - truncated
      - entities
      - licences
      title: CompanyResponse
    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
    CompanySummary:
      properties:
        total:
          type: integer
          title: Total
        by_service:
          additionalProperties:
            type: integer
          type: object
          title: By Service
        by_status:
          additionalProperties:
            type: integer
          type: object
          title: By Status
        provenance:
          items:
            $ref: '#/components/schemas/Provenance'
          type: array
          title: Provenance
      type: object
      required:
      - total
      - by_service
      - by_status
      - provenance
      title: CompanySummary
    UpcomingExpiry:
      properties:
        usi:
          type: integer
          title: Usi
        callsign:
          anyOf:
          - type: string
          - type: 'null'
          title: Callsign
        expiry_date:
          type: string
          format: date
          title: Expiry Date
        provenance:
          $ref: '#/components/schemas/Provenance'
      type: object
      required:
      - usi
      - expiry_date
      - provenance
      title: UpcomingExpiry