krimskrams-xyz Government License Data API

openapi: 3.2.0
info:
  title: FCC License Search Government License Data 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: Government License Data
paths:
  /mpp/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_mpp_mpp_v1_search_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchResponse'
        '402':
          description: Payment Required
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.020000'
        protocols:
        - mpp:
            method: tempo
            intent: charge
            currency: '0x20C000000000000000000000b9537d11c60E8b50'
      parameters:
      - name: q
        in: query
        required: true
        schema:
          maxLength: 200
          minLength: 1
          title: Q
          type: string
      - name: service
        in: query
        required: false
        schema:
          anyOf:
          - pattern: ^[A-Za-z0-9]{2}$
            type: string
          - type: 'null'
          title: Service
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - pattern: (?i)^[ACEFLMPQTX]$
            type: string
          - type: 'null'
          title: Status
      - name: limit
        in: query
        required: false
        schema:
          default: 10
          maximum: 20
          minimum: 1
          title: Limit
          type: integer
      tags:
      - Government License Data
  /mpp/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_mpp_mpp_v1_company_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompanyResponse'
        '402':
          description: Payment Required
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '0.100000'
        protocols:
        - mpp:
            method: tempo
            intent: charge
            currency: '0x20C000000000000000000000b9537d11c60E8b50'
      parameters:
      - name: company_name
        in: query
        required: true
        schema:
          maxLength: 200
          minLength: 1
          title: Company Name
          type: string
      - name: state
        in: query
        required: false
        schema:
          anyOf:
          - pattern: (?i)^[A-Z]{2}$
            type: string
          - type: 'null'
          title: State
      - name: service
        in: query
        required: false
        schema:
          anyOf:
          - pattern: ^[A-Za-z0-9]{2}$
            type: string
          - type: 'null'
          title: Service
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - pattern: (?i)^[ACEFLMPQTX]$
            type: string
          - type: 'null'
          title: Status
      - name: include_expired
        in: query
        required: false
        schema:
          default: true
          title: Include Expired
          type: boolean
      - name: limit
        in: query
        required: false
        schema:
          default: 100
          maximum: 1000
          minimum: 1
          title: Limit
          type: integer
      tags:
      - Government License Data
  /mpp/v1/snapshot/{slice_id}:
    get:
      summary: Download an FCC licence snapshot slice
      description: Download one FCC radio licence snapshot by slice_id from /v1/snapshots. Receive as_of, row_count, source, licence, and all rows with company name, call sign, FRN, service, status, grant, expiry, and cancellation dates as JSON.
      operationId: snapshot_mpp_mpp_v1_snapshot__slice_id__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnapshotResponse'
        '402':
          description: Payment Required
      x-payment-info:
        price:
          mode: fixed
          currency: USD
          amount: '1.000000'
        protocols:
        - mpp:
            method: tempo
            intent: charge
            currency: '0x20C000000000000000000000b9537d11c60E8b50'
      parameters:
      - name: slice_id
        in: path
        required: true
        schema:
          maxLength: 80
          minLength: 1
          pattern: ^[a-z0-9-]+$
          title: Slice Id
          type: string
      tags:
      - Government License Data
components:
  schemas:
    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
    SnapshotResponse:
      properties:
        slice_id:
          type: string
          title: Slice Id
        as_of:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: As Of
        row_count:
          type: integer
          title: Row Count
        source:
          additionalProperties: true
          type: object
          title: Source
        licence:
          type: string
          title: Licence
        rows:
          items:
            $ref: '#/components/schemas/LicenseResult'
          type: array
          title: Rows
      type: object
      required:
      - slice_id
      - as_of
      - row_count
      - source
      - licence
      - rows
      title: SnapshotResponse
    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
    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
    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
    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
    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
    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