Skip to content
Hedge Developer Docs

Broker Appetite

GET
/api/v1/broker/appetite
curl --request GET \
  --url 'https://example.com/api/v1/broker/appetite?q=example'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
q
required
Q
string
state
Any of:
string
lob
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
BrokerAppetiteResponse
object
query
required
Query
string
state
Any of:
string
lob
Any of:
string
results
required
Results
Array<object>
BrokerAppetiteMarket
object
market_id
Any of:
string format: uuid
carrier_slug
Any of:
string
name
required
Name
string
logo_url
Any of:
string
lines
Lines
Array<object>
BrokerAppetiteLine

One line a market would write for the queried class, canonical slug (filterable, stable) + platform display label (renderable).

object
slug
required
Slug
string
label
required
Label
string
matched_program_keys
Matched Program Keys
Array<string>
matched_program_names
Matched Program Names
Array<string>
turnaround
Any of:
BrokerMarketTurnaroundStat

Per-carrier submit-to-quote turnaround, computed across the whole book.

Speed-only by design: how long a market takes to return a quote once we’ve sent the submission (first marketing → first quoting transition). No hit-rate or decline data is exposed to brokers, this answers “how long do I wait”, not “how often do they say no”.

object
carrier
required
Carrier
string
quotes_counted
required
Quotes Counted
integer
median_hours
required
Median Hours
number
avg_hours
required
Avg Hours
number
typical_turnaround
required
Typical Turnaround
string
pct_within_1d
required
Pct Within 1D
integer
pct_within_2d
required
Pct Within 2D
integer
pct_within_3d
required
Pct Within 3D
integer
pct_within_5d
required
Pct Within 5D
integer
pct_within_7d
required
Pct Within 7D
integer
Examplegenerated
{
  "query": "example",
  "state": "example",
  "lob": "example",
  "results": [
    {
      "market_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "carrier_slug": "example",
      "name": "example",
      "logo_url": "example",
      "lines": [
        {
          "slug": "example",
          "label": "example"
        }
      ],
      "matched_program_keys": [
        "example"
      ],
      "matched_program_names": [
        "example"
      ],
      "turnaround": {
        "carrier": "example",
        "quotes_counted": 1,
        "median_hours": 1,
        "avg_hours": 1,
        "typical_turnaround": "example",
        "pct_within_1d": 1,
        "pct_within_2d": 1,
        "pct_within_3d": 1,
        "pct_within_5d": 1,
        "pct_within_7d": 1
      }
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}