Appetite

The programs Hedge would try for lines, state and NAICS

Changed on

Deterministic, read-only (no submission is created). Returns the programs Hedge attaches on line of business for the request, after your brokerage's market, program and line settings and Hedge's state footprint: connected carrier APIs (channel: api) and portals Hedge drives (channel: portal). Email and manual-portal markets are listed only with all_channels: true (channel: email and channel: portal), each with an appetite status. Programs that only ever return a non-binding indication are never listed. A listing is a potential route, not a quote; for API and portal programs the carrier's own application answers appetite.

Hedge sends ONE program per market, channel and line. Every eligible sibling is listed; exactly one per market, channel and line is the default (default_lines), and the others name it in alternative_of. Programs that cannot be tried are in excluded with reason codes: your own Markets settings (broker_market_excluded, broker_program_excluded, broker_program_line_excluded), the program's lines and states (unsupported_requested_line, requested_coverage_mismatch, package_companion_not_requested, program_state_excluded, market_state_excluded, exposure_state_excluded), Hedge's state footprint (brokerage_state_unavailable), the request's facts (program_class_excluded, below_program_revenue_floor, above_program_revenue_limit), or program_unavailable when the program cannot be tried right now.

post/broker/catalog/query

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Request body

linesstring[] required

Hedge line slugs; businessowners expands to general liability plus property. Unknown values return 422 unknown_line.

statestring required

Primary risk state.

exposure_statesstring[]

Every location state; each must pass the market and program state checks.

naicsstring nullable
annual_revenue_centsinteger nullable

Optional. Missing revenue is a warning (revenue_unknown)

effective_datestring date nullable
all_channelsboolean

false (default): connected carrier APIs and the portals Hedge drives, with one default per market, channel and line. true: every channel, adding manual-portal (channel: portal) and email (channel: email) programs, an appetite status on each row, and Hedge's pre-checks for the hedge group (at most 8 per line).

Example request

{
  "lines": [
    "commercial_general_liability"
  ]
}

Response

Offered and excluded programs

catalog_versionstring required
generated_atstring date-time required

Example response

{
  "programs": [
    {
      "speed": {
        "label": "Usually within minutes"
      }
    }
  ],
  "excluded": [
    {
      "reasons": [
        "broker_program_excluded"
      ]
    }
  ]
}

Changes

    • warning

      added the new email enum value to the // response property for the response status

    • warning

      added the new email enum value to the // response property for the response status

    • warning

      added the new underwriter_review enum value to the /// response property for the response status

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      endpoint added