Get Catalog Market

curl --request GET \
  --url https://api.usenexio.com/api/v1/catalog/markets/{entity_key} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usenexio.com/api/v1/catalog/markets/{entity_key}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usenexio.com/api/v1/catalog/markets/{entity_key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usenexio.com/api/v1/catalog/markets/{entity_key}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usenexio.com/api/v1/catalog/markets/{entity_key}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usenexio.com/api/v1/catalog/markets/{entity_key}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "market": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_key": "<string>",
    "market_id": "<string>",
    "name": "<string>",
    "market_type": "<string>",
    "am_best_rating": "<string>",
    "effective_year": 123,
    "provenance": {
      "source_blob_ref": "<string>",
      "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "effective_from": "2023-11-07T05:31:56Z"
    },
    "products": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_key": "<string>",
        "market_entity_key": "<string>",
        "line": "<string>",
        "line_code": "<string>",
        "line_class": "<string>",
        "product_name": "<string>",
        "commission_new": 123,
        "commission_renewal": 123,
        "commission_is_percent": true,
        "appetite_strength": "<string>",
        "excluded_states": [
          "<string>"
        ],
        "state_scope": "<string>",
        "avoided": true,
        "prohibited_naics": [
          "<string>"
        ],
        "provenance": {
          "source_blob_ref": "<string>",
          "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "effective_from": "2023-11-07T05:31:56Z"
        },
        "citations": {},
        "signals": {}
      }
    ],
    "relationships": [
      {
        "family_entity": "<string>",
        "paper_status": "current",
        "execution_backed": true,
        "effective_from_date": "2023-12-25",
        "effective_to_date": "2023-12-25",
        "succession_date": "2023-12-25",
        "carrier_issued_codes": [
          "<string>"
        ],
        "source_blob_ref": "<string>"
      }
    ],
    "backing": "executed_agreement",
    "signals": {}
  },
  "appetite": [
    {
      "market_entity_key": "<string>",
      "segment": "<string>",
      "business_class": "<string>",
      "line": "<string>",
      "line_code": "<string>",
      "eligibility": "<string>",
      "confidence": 123,
      "provenance": {
        "source_blob_ref": "<string>",
        "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "effective_from": "2023-11-07T05:31:56Z"
      },
      "signals": {}
    }
  ]
}

GET

api

catalog

markets

{entity_key}

Get Catalog Market

curl --request GET \
  --url https://api.usenexio.com/api/v1/catalog/markets/{entity_key} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.usenexio.com/api/v1/catalog/markets/{entity_key}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.usenexio.com/api/v1/catalog/markets/{entity_key}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usenexio.com/api/v1/catalog/markets/{entity_key}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.usenexio.com/api/v1/catalog/markets/{entity_key}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.usenexio.com/api/v1/catalog/markets/{entity_key}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "market": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_key": "<string>",
    "market_id": "<string>",
    "name": "<string>",
    "market_type": "<string>",
    "am_best_rating": "<string>",
    "effective_year": 123,
    "provenance": {
      "source_blob_ref": "<string>",
      "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "effective_from": "2023-11-07T05:31:56Z"
    },
    "products": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "product_key": "<string>",
        "market_entity_key": "<string>",
        "line": "<string>",
        "line_code": "<string>",
        "line_class": "<string>",
        "product_name": "<string>",
        "commission_new": 123,
        "commission_renewal": 123,
        "commission_is_percent": true,
        "appetite_strength": "<string>",
        "excluded_states": [
          "<string>"
        ],
        "state_scope": "<string>",
        "avoided": true,
        "prohibited_naics": [
          "<string>"
        ],
        "provenance": {
          "source_blob_ref": "<string>",
          "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "effective_from": "2023-11-07T05:31:56Z"
        },
        "citations": {},
        "signals": {}
      }
    ],
    "relationships": [
      {
        "family_entity": "<string>",
        "paper_status": "current",
        "execution_backed": true,
        "effective_from_date": "2023-12-25",
        "effective_to_date": "2023-12-25",
        "succession_date": "2023-12-25",
        "carrier_issued_codes": [
          "<string>"
        ],
        "source_blob_ref": "<string>"
      }
    ],
    "backing": "executed_agreement",
    "signals": {}
  },
  "appetite": [
    {
      "market_entity_key": "<string>",
      "segment": "<string>",
      "business_class": "<string>",
      "line": "<string>",
      "line_code": "<string>",
      "eligibility": "<string>",
      "confidence": 123,
      "provenance": {
        "source_blob_ref": "<string>",
        "extraction_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "effective_from": "2023-11-07T05:31:56Z"
      },
      "signals": {}
    }
  ]
}

Citations

Every product on this response carries a citations object keyed by the commission field it cites, identical to the one served by List Catalog Products. A product cites the same passage on every payload it appears in, so a highlight a user opens from a market is the highlight the product browse showed. Read grain before rendering: region carries a page and a normalized 0-1 rectangle, document carries neither and must render differently. Products do not reach page grain and their quote is always null; the full rules, and why a product may cite only its document, are on the List Catalog Products page.

Authorizations

Authorization

string

header

required

Send the credential as Authorization: Bearer <key>.

Scoped partner credentials use the exclusive nxsk_v1_... namespace. Each scoped key is bound at issuance to one organization, one canonical named environment, an explicit engine set, and a least-privilege capability set. A malformed, unknown, rotated, or revoked nxsk_ key fails closed and is never retried as a legacy key.

Capabilities used by this API are runs:write, runs:read, engines:read, catalog:read, webhooks:manage, runs:defensibility:read, runs:test, conversations:use, and conversations:export. Operation descriptions name the required capability. Grandfathered nx_live_... and nx_test_... keys retain their existing broad access during the compatibility window.

Path Parameters

entity_key

string

required

Stable market entity key.

Query Parameters

connection_id

string<uuid>

Pin the browse to one active data connection. Optional when the org has a single active connection; required when it has more than one (an ambiguous request returns catalog_connection_ambiguous).

Response

The market head, its products, and its appetite cells.

market

object

required

Show child attributes

appetite

object[]

required

Show child attributes

Start Here

Guides

API Reference

Get Catalog Market

Citations

Authorizations

Path Parameters

Query Parameters

Response

​Citations

Authorizations

Path Parameters

Query Parameters

Response

Citations