RatesRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ticexplorer-com/json-schema/ticexplorer-com-rates-request-schema.json",
  "title": "RatesRequest",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ticexplorer-com-openapi.json#/components/schemas/RatesRequest",
  "properties": {
    "coverage": {
      "$ref": "#/$defs/Coverage"
    },
    "codes": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "maxItems": 10,
      "minItems": 1,
      "title": "Codes",
      "description": "Billing codes from find_codes (CPT/HCPCS, or an APC number for hospital case rates)."
    },
    "providers": {
      "anyOf": [
        {
          "$ref": "#/$defs/Providers"
        },
        {
          "type": "null"
        }
      ],
      "description": "Restrict to these billing entities / locations."
    },
    "area": {
      "$ref": "#/$defs/Area"
    },
    "limit": {
      "type": "integer",
      "maximum": 500.0,
      "minimum": 1.0,
      "title": "Limit",
      "default": 50
    },
    "cursor": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Cursor",
      "description": "Pagination cursor from next_cursor.",
      "default": 0
    },
    "wait_seconds": {
      "type": "integer",
      "maximum": 240.0,
      "minimum": 5.0,
      "title": "Wait Seconds",
      "description": "How long to wait for rate files being indexed for the first time.",
      "default": 60
    },
    "label": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Label",
      "description": "Echoed back in batch results."
    }
  },
  "type": "object",
  "required": [
    "coverage",
    "codes",
    "area"
  ],
  "$defs": {
    "Area": {
      "properties": {
        "zip": {
          "type": "string",
          "title": "Zip",
          "description": "5-digit ZIP the person is near."
        },
        "miles": {
          "type": "number",
          "maximum": 100.0,
          "minimum": 1.0,
          "title": "Miles",
          "description": "Search radius in miles.",
          "default": 15
        }
      },
      "type": "object",
      "required": [
        "zip"
      ],
      "title": "Area"
    },
    "Coverage": {
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "plan",
            "medicare",
            "hospital"
          ],
          "title": "Type",
          "description": "plan = a plan from find_plan (insurer rate files); medicare = Original Medicare fee schedule; hospital = hospitals' own price files (Medicare Advantage, Medicaid, cash/self-pay): each hospital's posted rate per payer/plan as the hospital wrote it (not necessarily the person's plan), mostly facility charges; cash = its discounted cash price, not the gross charge. price_claim does not accept hospital.",
          "default": "plan"
        },
        "plan_id": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Plan Id",
          "description": "Required when type = plan; from find_plan."
        },
        "hospital_coverage": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "title": "Hospital Coverage",
          "description": "For type = hospital: medicare_advantage | medicaid | cash | a payer name."
        }
      },
      "type": "object",
      "title": "Coverage"
    },
    "Providers": {
      "properties": {
        "tins": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Tins",
          "description": "Billing entity tax IDs (from find_providers), e.g. 84-1179794."
        },
        "npis": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Npis",
          "description": "NPIs of locations or clinicians."
        },
        "names": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "title": "Names",
          "description": "Substring match on billing entity / location names."
        }
      },
      "type": "object",
      "title": "Providers"
    }
  }
}