Structured appetite search (query + lines + state)

POST

/broker/appetite/search

const url = 'https://api.hedgespecialty.com/api/v1/broker/appetite/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"query":"example","state":"example","lines":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.hedgespecialty.com/api/v1/broker/appetite/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "query": "example", "state": "example", "lines": [ "example" ] }'

The portal’s placement search: a free-text risk description plus optional lines and state, returning ranked markets with matched programs and their Hedge category. Same daily limit as GET /broker/appetite.

Authorizations

brokerOAuth

Request Body^required

application/json

object

query

string

<= 2000 characters

state

string

>= 2 characters <= 2 characters

lines

Array<string>

<= 30 items

Example^generated

{
  "query": "example",
  "state": "example",
  "lines": [
    "example"
  ]
}

Structured appetite search (query + lines + state)

Authorizations

Request Body^required

Example^generated

Responses

200

429

Structured appetite search (query + lines + state)

Authorizations

Request Bodyrequired

Examplegenerated

Responses

200

429

Request Body^required

Example^generated