Skip to content
Hedge Developer Docs

Quickstart

The fastest path to a working integration is the hedge CLI. Install it, sign in once, and you can check appetite and submit risks from your terminal or a script. If you would rather call the REST API directly, skip to Call the API directly.

Use the CLI

Section titled “Use the CLI”

  1. Install the CLI.

    Terminal window
    npm i -g hedge-broker

    Homebrew and a one-line install script are also available. See the CLI guide for all three options.

  2. Sign in.

    Terminal window
    hedge login

    hedge login uses the OAuth 2.1 device flow: it prints a short code and a URL, you approve the sign-in in the broker portal, and the CLI stores a short-lived token for you. Prefer a browser sign-in? Run hedge login --browser.

  3. Check appetite.

    Terminal window
    hedge appetite "roofing" --state CA

    You get back the markets that want that class of business in California, with the matching programs and what each one needs to quote.

  4. Create a submission.

    Terminal window
    hedge submit \
      --insured "Acme Roofing LLC" \
      --state CA \
      --line "General Liability" \
      --narrative "Residential roofing contractor, 12 employees, no prior losses."

    This creates the submission and returns its id. Add documents with hedge upload, see what is still needed with hedge requirements, and hand it to Hedge to market with hedge finalize. Run hedge submit --help for the full flag list.

Call the API directly

Section titled “Call the API directly”

Every CLI command maps to a REST endpoint under https://api.hedgespecialty.com/api/v1. Requests are JSON over HTTPS and carry a short-lived OAuth 2.1 bearer token in the Authorization header. See Authentication for how to obtain one.

Check appetite

Section titled “Check appetite”
Terminal window
curl -G "https://api.hedgespecialty.com/api/v1/broker/appetite" \
  --data-urlencode "q=roofing" \
  --data-urlencode "state=CA" \
  -H "Authorization: Bearer $HEDGE_TOKEN"

Create a submission

Section titled “Create a submission”

Creating a submission needs the broker_submit scope. The only required field is the applicant’s insured_name; everything else is optional and helps carriers quote faster.

Terminal window
curl -X POST "https://api.hedgespecialty.com/api/v1/broker/submissions" \
  -H "Authorization: Bearer $HEDGE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "applicant": {
      "insured_name": "Acme Roofing LLC",
      "mailing_address": {
        "line1": "100 Market St",
        "city": "San Jose",
        "state": "CA",
        "zip": "95113",
        "country": "US"
      },
      "naics": "238160"
    },
    "lines_of_business": ["General Liability"],
    "effective_date": "2026-08-01",
    "narrative": "Residential roofing contractor, 12 employees, no prior losses."
  }'

The response contains the new submission, including its id, which you use to upload documents, poll requirements, and finalize. Continue in the API Reference.

Where to go next

Section titled “Where to go next”

Set up the OAuth 2.1 device flow, browser sign-in, or a connected app for server-to-server calls. See Authentication.