Generated from OpenAPI 1.0.0-beta.1
API reference Exact operations, parameters and response schemas for the developer API. For a guided first request, start with Quickstart .
Download OpenAPI JSON GET /v1/preview/opportunities GET /v1/opportunities GET /v1/opportunities/count GET /v1/opportunities/{opportunity_id} GET /v1/buyer-intelligence/organizations GET /v1/buyer-intelligence/watchlists GET /v1/buyer-intelligence/watchlists/{watchlist_id} GET /v1/buyer-intelligence/watchlists/{watchlist_id}/accounts GET /v1/buyer-intelligence/watchlists/{watchlist_id}/accounts/{organization_key} GET /v1/buyer-intelligence/watchlists/{watchlist_id}/events GET /v1/buyer-intelligence/watchlists/{watchlist_id}/companies/{organization_key} GET /v1/buyer-intelligence/watchlists/{watchlist_id}/companies/{organization_key}/profiles GET /v1/buyer-intelligence/watchlists/{watchlist_id}/weekly-report GET /v1/buyer-intelligence/watchlists/{watchlist_id}/export.csv GET /v1/taxonomy/occupations GET /v1/opportunities List U.S. technology job opportunities Returns already-computed canonical U.S. technology-job intelligence. Filters operate on persisted taxonomy, commercial evidence, location, freshness, and liveness fields. Use the signed `pagination.next_cursor` value unchanged with the same filters to fetch the next page. Normal access supports `limit` values up to 100, but the effective account maximum may be lower.
Parameters Name Location Contract published_after query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Published After"
} published_before query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Published Before"
} fresh_after query Earliest provider publication time, falling back to Radar first-seen time when the provider does not publish a date. The response never fabricates published_at.{
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"description": "Earliest provider publication time, falling back to Radar first-seen time when the provider does not publish a date. The response never fabricates published_at.",
"title": "Fresh After"
} job_domain query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Domain"
} job_family query Comma-separated family IDs. A family includes every descendant role.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated family IDs. A family includes every descendant role.",
"title": "Job Family"
} job_subfamily query Comma-separated subfamily IDs that narrow any selected family.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated subfamily IDs that narrow any selected family.",
"title": "Job Subfamily"
} job_class query Comma-separated exact occupational class/role IDs.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated exact occupational class/role IDs.",
"title": "Job Class"
} normalized_title query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Normalized Title"
} level query Comma-separated, e.g. staff,principal.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated, e.g. staff,principal.",
"title": "Level"
} management_track query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Management Track"
} specializations query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Specializations"
} engagement_model query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Engagement Model"
} commercial_eligibility query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Commercial Eligibility"
} actionability query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Actionability"
} remote query {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Remote"
} country query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country"
} state query State or region alias.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "State or region alias.",
"title": "State"
} region query State or region.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "State or region.",
"title": "Region"
} city query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City"
} rate_min query {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
},
{
"type": "null"
}
],
"title": "Rate Min"
} rate_max query {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
},
{
"type": "null"
}
],
"title": "Rate Max"
} currency query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
} pay_basis query Comma-separated normalized values: hourly, daily, monthly, annual, fixed_project, or unknown.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated normalized values: hourly, daily, monthly, annual, fixed_project, or unknown.",
"title": "Pay Basis"
} work_structure query Comma-separated normalized values: fixed_project, ongoing_contract, contract_duration, freelance_ad_hoc, or unknown.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Comma-separated normalized values: fixed_project, ongoing_contract, contract_duration, freelance_ad_hoc, or unknown.",
"title": "Work Structure"
} include_low_pay query Include listings below Radar's compensation quality floor.{
"type": "boolean",
"description": "Include listings below Radar's compensation quality floor.",
"default": true,
"title": "Include Low Pay"
} source query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
} liveness_status query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Liveness Status"
} first_seen_after query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "First Seen After"
} changed_since query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Changed Since"
} cursor query Opaque signed cursor returned as `pagination.next_cursor`. It is query-specific; pass it back unchanged and do not construct or modify it.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Opaque signed cursor returned as `pagination.next_cursor`. It is query-specific; pass it back unchanged and do not construct or modify it.",
"title": "Cursor"
} limit query {
"type": "integer",
"maximum": 100,
"minimum": 1,
"default": 25,
"title": "Limit"
} X-Request-ID header Unique caller-generated identifier for this billable request. Reuse can return `409 duplicate_request_id`.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique caller-generated identifier for this billable request. Reuse can return `409 duplicate_request_id`.",
"title": "X-Request-Id"
}
Response contracts {
"200": {
"description": "Canonical opportunity page with cursor, request, rate-limit, and plan usage metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpportunityListResponse"
}
}
},
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
}
},
"400": {
"description": "Invalid request (`invalid_filter`, `malformed_cursor`, or `page_size_exceeded`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"401": {
"description": "Authentication failed (`missing_api_key`, `invalid_api_key`, or `revoked_api_key`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"402": {
"description": "Included allowance and prepaid balance are insufficient (`insufficient_balance`), or a historical entitlement exhausted its legacy allowance (`opportunity_quota_exhausted`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "Access is unavailable (`api_access_disabled`, `api_access_suspended`, or an inactive historical entitlement such as `plan_access_pending` or `plan_access_expired`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "The requested canonical opportunity does not exist (`opportunity_not_found`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"409": {
"description": "The billable `X-Request-ID` was already used (`duplicate_request_id`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"422": {
"description": "Request parameter validation failed (`validation_error`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"429": {
"description": "Authenticated request limit exceeded (`rate_limit_exceeded`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
},
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Seconds to wait before retrying."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected server error (`internal_server_error`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"503": {
"description": "Usage metering is temporarily unavailable (`metering_unavailable`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
} GET /v1/opportunities/count Count matching opportunities without consuming opportunity quota
Parameters Name Location Contract published_after query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Published After"
} published_before query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Published Before"
} fresh_after query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Fresh After"
} job_domain query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Domain"
} job_family query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Family"
} job_subfamily query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Subfamily"
} job_class query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Class"
} normalized_title query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Normalized Title"
} level query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Level"
} management_track query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Management Track"
} specializations query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Specializations"
} engagement_model query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Engagement Model"
} commercial_eligibility query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Commercial Eligibility"
} actionability query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Actionability"
} remote query {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Remote"
} country query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country"
} state query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State"
} region query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Region"
} city query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City"
} rate_min query {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
},
{
"type": "null"
}
],
"title": "Rate Min"
} rate_max query {
"anyOf": [
{
"type": "number",
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
},
{
"type": "null"
}
],
"title": "Rate Max"
} currency query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
} pay_basis query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pay Basis"
} work_structure query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Work Structure"
} include_low_pay query Include listings below Radar's compensation quality floor.{
"type": "boolean",
"description": "Include listings below Radar's compensation quality floor.",
"default": true,
"title": "Include Low Pay"
} source query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source"
} liveness_status query {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Liveness Status"
} first_seen_after query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "First Seen After"
} changed_since query {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Changed Since"
}
Response contracts {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpportunityCountResponse"
}
}
}
},
"400": {
"description": "Invalid request (`invalid_filter`, `malformed_cursor`, or `page_size_exceeded`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"401": {
"description": "Authentication failed (`missing_api_key`, `invalid_api_key`, or `revoked_api_key`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"402": {
"description": "Included allowance and prepaid balance are insufficient (`insufficient_balance`), or a historical entitlement exhausted its legacy allowance (`opportunity_quota_exhausted`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "Access is unavailable (`api_access_disabled`, `api_access_suspended`, or an inactive historical entitlement such as `plan_access_pending` or `plan_access_expired`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "The requested canonical opportunity does not exist (`opportunity_not_found`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"409": {
"description": "The billable `X-Request-ID` was already used (`duplicate_request_id`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"422": {
"description": "Request parameter validation failed (`validation_error`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"429": {
"description": "Authenticated request limit exceeded (`rate_limit_exceeded`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
},
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Seconds to wait before retrying."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected server error (`internal_server_error`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"503": {
"description": "Usage metering is temporarily unavailable (`metering_unavailable`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
} GET /v1/opportunities/{opportunity_id} Get one canonical opportunity Returns one already-persisted canonical opportunity. Send a unique `X-Request-ID` for the billable authenticated request.
Parameters Name Location Contract opportunity_id * path Stable Radar opportunity ID.{
"type": "string",
"format": "uuid",
"description": "Stable Radar opportunity ID.",
"title": "Opportunity Id"
} X-Request-ID header Unique caller-generated identifier for this billable request. Reuse can return `409 duplicate_request_id`.{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"description": "Unique caller-generated identifier for this billable request. Reuse can return `409 duplicate_request_id`.",
"title": "X-Request-Id"
}
Response contracts {
"200": {
"description": "Canonical opportunity page with cursor, request, rate-limit, and plan usage metadata.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpportunityDetailResponse"
}
}
},
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
}
},
"400": {
"description": "Invalid request (`invalid_filter`, `malformed_cursor`, or `page_size_exceeded`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"401": {
"description": "Authentication failed (`missing_api_key`, `invalid_api_key`, or `revoked_api_key`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"402": {
"description": "Included allowance and prepaid balance are insufficient (`insufficient_balance`), or a historical entitlement exhausted its legacy allowance (`opportunity_quota_exhausted`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"403": {
"description": "Access is unavailable (`api_access_disabled`, `api_access_suspended`, or an inactive historical entitlement such as `plan_access_pending` or `plan_access_expired`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"404": {
"description": "The requested canonical opportunity does not exist (`opportunity_not_found`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"409": {
"description": "The billable `X-Request-ID` was already used (`duplicate_request_id`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"422": {
"description": "Request parameter validation failed (`validation_error`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"429": {
"description": "Authenticated request limit exceeded (`rate_limit_exceeded`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
},
"Retry-After": {
"schema": {
"type": "integer"
},
"description": "Seconds to wait before retrying."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"500": {
"description": "Unexpected server error (`internal_server_error`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
},
"503": {
"description": "Usage metering is temporarily unavailable (`metering_unavailable`).",
"headers": {
"X-Request-ID": {
"schema": {
"type": "string"
},
"description": "Unique request identifier supplied by the caller or generated by Radar."
},
"X-RateLimit-Limit": {
"schema": {
"type": "integer"
},
"description": "Effective authenticated request limit for the current window."
},
"X-RateLimit-Remaining": {
"schema": {
"type": "integer"
},
"description": "Requests remaining in the current rate-limit window."
},
"X-RateLimit-Reset": {
"schema": {
"type": "integer"
},
"description": "Seconds until the current rate-limit window resets."
},
"X-Radar-Balance-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Remaining prepaid wallet balance. 100,000 millicents equals one USD."
},
"X-Radar-Usage-Charge-Millicents": {
"schema": {
"type": "integer",
"format": "int64"
},
"description": "Prepaid PAYG wallet amount charged for this response."
},
"X-Radar-Prepaid-Opportunity-Credits": {
"schema": {
"type": "integer"
},
"description": "Additional opportunities affordable from the prepaid PAYG balance."
},
"X-Radar-Plan": {
"schema": {
"type": "string"
},
"description": "Current Radar plan for plan-billed accounts."
},
"X-Radar-Opportunity-Limit": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunity allowance for the current plan period."
},
"X-Radar-Opportunity-Used": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities delivered in the current plan period."
},
"X-Radar-Opportunity-Remaining": {
"schema": {
"type": "integer"
},
"description": "Unique canonical opportunities remaining in the current plan period."
},
"X-Radar-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New period-scoped canonical opportunity exposures in this response."
},
"X-Radar-Included-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to included plan allowance."
},
"X-Radar-PAYG-New-Opportunity-Count": {
"schema": {
"type": "integer"
},
"description": "New canonical opportunities charged to prepaid PAYG credit."
},
"X-RapidAPI-Billing": {
"schema": {
"type": "string",
"example": "Opportunities=17"
},
"description": "RapidAPI custom billing object emitted only for a verified RapidAPI proxy request."
},
"X-Radar-Period-End": {
"schema": {
"type": "string",
"format": "date-time"
},
"description": "Exclusive end of the current plan period."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/APIErrorResponse"
}
}
}
}
} Schemas OpportunityListResponse {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PublicOpportunity"
},
"type": "array",
"title": "Data"
},
"pagination": {
"$ref": "#/components/schemas/Pagination"
},
"meta": {
"$ref": "#/components/schemas/ResponseMeta"
}
},
"type": "object",
"required": [
"data",
"pagination",
"meta"
],
"title": "OpportunityListResponse"
} PublicOpportunity {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"title": {
"type": "string",
"title": "Title"
},
"normalized_title": {
"type": "string",
"title": "Normalized Title"
},
"employer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Employer"
},
"intermediary": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Intermediary"
},
"organizations": {
"items": {
"$ref": "#/components/schemas/PublicOrganization"
},
"type": "array",
"title": "Organizations"
},
"canonical_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2083,
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Canonical Url",
"description": "Canonical source/listing URL for the opportunity manifestation."
},
"application_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2083,
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Application Url",
"description": "Best known safe application destination; falls back to the raw source-provided application URL when destination resolution is unavailable."
},
"sources": {
"items": {
"$ref": "#/components/schemas/PublicSource"
},
"type": "array",
"title": "Sources"
},
"published_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Published At"
},
"published_precision": {
"type": "string",
"title": "Published Precision"
},
"first_seen": {
"type": "string",
"format": "date-time",
"title": "First Seen"
},
"changed_at": {
"type": "string",
"format": "date-time",
"title": "Changed At"
},
"last_verified_live_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Verified Live At"
},
"liveness_status": {
"type": "string",
"title": "Liveness Status"
},
"technology_classification": {
"type": "string",
"title": "Technology Classification"
},
"job_domain": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Domain"
},
"job_family": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Family"
},
"job_subfamily": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Subfamily"
},
"job_class": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Class"
},
"level": {
"type": "string",
"title": "Level"
},
"management_track": {
"type": "string",
"title": "Management Track"
},
"specializations": {
"items": {
"type": "string"
},
"type": "array",
"title": "Specializations"
},
"engagement_models": {
"items": {
"type": "string"
},
"type": "array",
"title": "Engagement Models"
},
"employment_relationship": {
"type": "string",
"title": "Employment Relationship",
"default": "unknown"
},
"engagement_resolution": {
"additionalProperties": true,
"type": "object",
"title": "Engagement Resolution",
"description": "Current evidence restrictions and unresolved subtype conflicts; original evidence is preserved."
},
"commercial_eligibility": {
"type": "string",
"title": "Commercial Eligibility"
},
"actionability": {
"type": "string",
"title": "Actionability"
},
"location": {
"$ref": "#/components/schemas/PublicLocation"
},
"rate": {
"anyOf": [
{
"$ref": "#/components/schemas/PublicRate"
},
{
"type": "null"
}
]
},
"is_low_pay": {
"type": "boolean",
"title": "Is Low Pay",
"default": false
},
"pay_basis": {
"type": "string",
"title": "Pay Basis",
"default": "unknown"
},
"work_structure": {
"type": "string",
"title": "Work Structure",
"default": "unknown"
},
"duration": {
"anyOf": [
{
"$ref": "#/components/schemas/PublicContractDuration"
},
{
"type": "null"
}
]
},
"evidence": {
"items": {
"$ref": "#/components/schemas/PublicEvidence"
},
"type": "array",
"title": "Evidence"
},
"taxonomy_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Taxonomy Version"
},
"intelligence_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Intelligence Version"
}
},
"type": "object",
"required": [
"id",
"title",
"normalized_title",
"employer",
"intermediary",
"canonical_url",
"application_url",
"published_at",
"published_precision",
"first_seen",
"changed_at",
"last_verified_live_at",
"liveness_status",
"technology_classification",
"job_domain",
"job_family",
"job_subfamily",
"job_class",
"level",
"management_track",
"commercial_eligibility",
"actionability",
"location",
"rate",
"taxonomy_version",
"intelligence_version"
],
"title": "PublicOpportunity"
} PublicOrganization {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Roles"
},
"organization_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Key"
},
"canonical_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Canonical Id"
},
"canonical_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Canonical Name"
},
"organization_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Organization Type"
},
"identity_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Identity Status"
},
"identity_evidence_url": {
"anyOf": [
{
"type": "string",
"maxLength": 2083,
"minLength": 1,
"format": "uri"
},
{
"type": "null"
}
],
"title": "Identity Evidence Url"
}
},
"type": "object",
"required": [
"name"
],
"title": "PublicOrganization"
} PublicSource {
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"slug": {
"type": "string",
"title": "Slug"
},
"listing_url": {
"type": "string",
"maxLength": 2083,
"minLength": 1,
"format": "uri",
"title": "Listing Url"
},
"canonicality": {
"type": "string",
"title": "Canonicality"
},
"first_seen": {
"type": "string",
"format": "date-time",
"title": "First Seen"
},
"last_observed_at": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Last Observed At"
}
},
"type": "object",
"required": [
"name",
"slug",
"listing_url",
"canonicality",
"first_seen",
"last_observed_at"
],
"title": "PublicSource"
} PublicLocation {
"properties": {
"text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Text"
},
"remote": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Remote"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country"
},
"region": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Region"
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City"
}
},
"type": "object",
"title": "PublicLocation"
} PublicRate {
"properties": {
"minimum": {
"anyOf": [
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
},
{
"type": "null"
}
],
"title": "Minimum",
"description": "Normalized lower compensation bound, without display symbols."
},
"maximum": {
"anyOf": [
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"
},
{
"type": "null"
}
],
"title": "Maximum",
"description": "Normalized upper compensation bound, without display symbols."
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "Explicit normalized ISO-like source currency when known."
},
"unit": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Unit",
"description": "Normalized pay period: hour, day, week, month, year, or project."
},
"source_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Text",
"description": "Original source compensation evidence; structured fields are authoritative."
},
"qualitative": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Qualitative",
"description": "Reserved for backward compatibility. Unknown or qualitative source compensation is not exposed as customer-facing compensation."
}
},
"type": "object",
"title": "PublicRate"
} PublicContractDuration {
"properties": {
"value": {
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
"title": "Value",
"description": "Positive duration value stated by the source."
},
"unit": {
"type": "string",
"title": "Unit",
"description": "Normalized duration unit: day, week, month, or year."
},
"source_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Text",
"description": "Exact source fragment supporting the normalized duration."
}
},
"type": "object",
"required": [
"value",
"unit"
],
"title": "PublicContractDuration"
} PublicEvidence {
"properties": {
"kind": {
"type": "string",
"title": "Kind"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Label"
},
"excerpt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Excerpt"
}
},
"type": "object",
"required": [
"kind"
],
"title": "PublicEvidence"
} ResponseMeta {
"properties": {
"request_id": {
"type": "string",
"title": "Request Id"
},
"applied_filters": {
"additionalProperties": true,
"type": "object",
"title": "Applied Filters"
}
},
"type": "object",
"required": [
"request_id"
],
"title": "ResponseMeta"
} APIErrorResponse {
"properties": {
"error": {
"$ref": "#/components/schemas/ErrorBody"
}
},
"type": "object",
"required": [
"error"
],
"title": "APIErrorResponse"
} ErrorBody {
"properties": {
"code": {
"type": "string",
"title": "Code"
},
"message": {
"type": "string",
"title": "Message"
},
"request_id": {
"type": "string",
"title": "Request Id"
},
"details": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Details"
}
},
"type": "object",
"required": [
"code",
"message",
"request_id"
],
"title": "ErrorBody"
} OpportunityCountResponse {
"properties": {
"count": {
"type": "integer",
"title": "Count"
},
"meta": {
"$ref": "#/components/schemas/ResponseMeta"
}
},
"type": "object",
"required": [
"count",
"meta"
],
"title": "OpportunityCountResponse"
} OpportunityDetailResponse {
"properties": {
"data": {
"$ref": "#/components/schemas/PublicOpportunity"
},
"meta": {
"$ref": "#/components/schemas/ResponseMeta"
}
},
"type": "object",
"required": [
"data",
"meta"
],
"title": "OpportunityDetailResponse"
} OrganizationListResponse {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/OrganizationSummary"
},
"type": "array",
"title": "Data"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"truncated",
"request_id"
],
"title": "OrganizationListResponse"
} OrganizationSummary {
"properties": {
"organization_key": {
"type": "string",
"title": "Organization Key"
},
"display_name": {
"type": "string",
"title": "Display Name"
},
"canonical_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Canonical Id"
},
"canonical_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Canonical Name"
},
"organization_type": {
"type": "string",
"title": "Organization Type"
},
"identity_status": {
"type": "string",
"title": "Identity Status"
},
"aliases": {
"items": {
"type": "string"
},
"type": "array",
"title": "Aliases"
},
"evidence": {
"additionalProperties": true,
"type": "object",
"title": "Evidence"
},
"first_observed_at": {
"type": "string",
"format": "date-time",
"title": "First Observed At"
},
"last_observed_at": {
"type": "string",
"format": "date-time",
"title": "Last Observed At"
}
},
"type": "object",
"required": [
"organization_key",
"display_name",
"canonical_id",
"canonical_name",
"organization_type",
"identity_status",
"aliases",
"evidence",
"first_observed_at",
"last_observed_at"
],
"title": "OrganizationSummary"
} HTTPValidationError {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
} ValidationError {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
},
"input": {
"title": "Input"
},
"ctx": {
"type": "object",
"title": "Context"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
} WatchlistListResponse {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/WatchlistSummary"
},
"type": "array",
"title": "Data"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"request_id"
],
"title": "WatchlistListResponse"
} WatchlistSummary {
"properties": {
"id": {
"type": "string",
"format": "uuid",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"buyer_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Buyer Name"
},
"buyer_email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Buyer Email"
},
"segment_definition": {
"additionalProperties": true,
"type": "object",
"title": "Segment Definition"
},
"status": {
"type": "string",
"enum": [
"active",
"archived"
],
"title": "Status"
},
"account_count": {
"type": "integer",
"title": "Account Count"
},
"created_by": {
"type": "string",
"title": "Created By"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"updated_at": {
"type": "string",
"format": "date-time",
"title": "Updated At"
}
},
"type": "object",
"required": [
"id",
"name",
"buyer_name",
"buyer_email",
"segment_definition",
"status",
"account_count",
"created_by",
"created_at",
"updated_at"
],
"title": "WatchlistSummary"
} CreateWatchlistRequest {
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"title": "Name"
},
"buyer_name": {
"anyOf": [
{
"type": "string",
"maxLength": 200
},
{
"type": "null"
}
],
"title": "Buyer Name"
},
"buyer_email": {
"anyOf": [
{
"type": "string",
"maxLength": 320
},
{
"type": "null"
}
],
"title": "Buyer Email"
},
"segment_definition": {
"additionalProperties": true,
"type": "object",
"title": "Segment Definition"
}
},
"type": "object",
"required": [
"name"
],
"title": "CreateWatchlistRequest"
} WatchlistResponse {
"properties": {
"data": {
"$ref": "#/components/schemas/WatchlistSummary"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"request_id"
],
"title": "WatchlistResponse"
} UpdateWatchlistRequest {
"properties": {
"status": {
"type": "string",
"enum": [
"active",
"archived"
],
"title": "Status"
}
},
"type": "object",
"required": [
"status"
],
"title": "UpdateWatchlistRequest"
} WatchlistAccountResponse {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/WatchlistAccountRecord"
},
"type": "array",
"title": "Data"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"request_id"
],
"title": "WatchlistAccountResponse"
} WatchlistAccountRecord {
"properties": {
"organization_key": {
"type": "string",
"title": "Organization Key"
},
"organization_name": {
"type": "string",
"title": "Organization Name"
},
"identity_status": {
"type": "string",
"title": "Identity Status"
},
"organization_type": {
"type": "string",
"title": "Organization Type"
},
"priority": {
"type": "integer",
"title": "Priority"
},
"notes": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes"
},
"added_at": {
"type": "string",
"format": "date-time",
"title": "Added At"
}
},
"type": "object",
"required": [
"organization_key",
"organization_name",
"identity_status",
"organization_type",
"priority",
"notes",
"added_at"
],
"title": "WatchlistAccountRecord"
} AddWatchlistAccountsRequest {
"properties": {
"accounts": {
"items": {
"$ref": "#/components/schemas/WatchlistAccountInput"
},
"type": "array",
"maxItems": 25,
"minItems": 1,
"title": "Accounts"
}
},
"type": "object",
"required": [
"accounts"
],
"title": "AddWatchlistAccountsRequest"
} WatchlistAccountInput {
"properties": {
"organization_key": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"title": "Organization Key"
},
"notes": {
"anyOf": [
{
"type": "string",
"maxLength": 5000
},
{
"type": "null"
}
],
"title": "Notes"
}
},
"type": "object",
"required": [
"organization_key"
],
"title": "WatchlistAccountInput"
} DemandFeedResponse {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DemandSignalRecord"
},
"type": "array",
"title": "Data"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"truncated",
"request_id"
],
"title": "DemandFeedResponse"
} DemandSignalRecord {
"properties": {
"event_id": {
"type": "string",
"format": "uuid",
"title": "Event Id"
},
"event_key": {
"type": "string",
"title": "Event Key"
},
"organization_key": {
"type": "string",
"title": "Organization Key"
},
"organization_name": {
"type": "string",
"title": "Organization Name"
},
"event_type": {
"type": "string",
"title": "Event Type"
},
"occurred_at": {
"type": "string",
"format": "date-time",
"title": "Occurred At"
},
"change_kinds": {
"items": {
"type": "string"
},
"type": "array",
"title": "Change Kinds"
},
"title": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"job_family": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Job Family"
},
"technologies": {
"items": {
"type": "string"
},
"type": "array",
"title": "Technologies"
},
"engagement_models": {
"items": {
"type": "string"
},
"type": "array",
"title": "Engagement Models"
},
"compensation": {
"additionalProperties": true,
"type": "object",
"title": "Compensation"
},
"duration": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Duration"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location"
},
"organization_roles": {
"items": {
"type": "string"
},
"type": "array",
"title": "Organization Roles"
},
"source_name": {
"type": "string",
"title": "Source Name"
},
"source_url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Source Url"
},
"evidence": {
"additionalProperties": true,
"type": "object",
"title": "Evidence"
},
"disposition": {
"type": "string",
"enum": [
"new",
"acknowledged",
"dismissed",
"acted_on",
"incorrect"
],
"title": "Disposition"
},
"annotation": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Annotation"
}
},
"type": "object",
"required": [
"event_id",
"event_key",
"organization_key",
"organization_name",
"event_type",
"occurred_at",
"change_kinds",
"title",
"job_family",
"technologies",
"engagement_models",
"compensation",
"duration",
"location",
"organization_roles",
"source_name",
"source_url",
"evidence",
"disposition",
"annotation"
],
"title": "DemandSignalRecord"
} CompanyDossierResponse {
"properties": {
"data": {
"$ref": "#/components/schemas/CompanyDossier"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"request_id"
],
"title": "CompanyDossierResponse"
} CompanyDossier {
"properties": {
"organization": {
"additionalProperties": true,
"type": "object",
"title": "Organization"
},
"profile": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Profile"
},
"employment_context": {
"additionalProperties": true,
"type": "object",
"title": "Employment Context"
},
"signals": {
"items": {
"$ref": "#/components/schemas/DemandSignalRecord"
},
"type": "array",
"title": "Signals"
},
"signals_truncated": {
"type": "boolean",
"title": "Signals Truncated"
}
},
"type": "object",
"required": [
"organization",
"profile",
"employment_context",
"signals",
"signals_truncated"
],
"title": "CompanyDossier"
} CapacityProfileHistoryResponse {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CapacityProfileVersion"
},
"type": "array",
"title": "Data"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"truncated",
"request_id"
],
"title": "CapacityProfileHistoryResponse"
} CapacityProfileVersion {
"properties": {
"profile_version": {
"type": "string",
"title": "Profile Version"
},
"as_of": {
"type": "string",
"format": "date-time",
"title": "As Of"
},
"state_hash": {
"type": "string",
"title": "State Hash"
},
"current_role_count": {
"type": "integer",
"title": "Current Role Count"
},
"source_event_count": {
"type": "integer",
"title": "Source Event Count"
},
"profile": {
"additionalProperties": true,
"type": "object",
"title": "Profile"
}
},
"type": "object",
"required": [
"profile_version",
"as_of",
"state_hash",
"current_role_count",
"source_event_count",
"profile"
],
"title": "CapacityProfileVersion"
} WeeklyReportResponse {
"properties": {
"data": {
"$ref": "#/components/schemas/WeeklyReport"
},
"request_id": {
"type": "string",
"title": "Request Id"
}
},
"type": "object",
"required": [
"data",
"request_id"
],
"title": "WeeklyReportResponse"
} WeeklyReport {
"properties": {
"watchlist_id": {
"type": "string",
"format": "uuid",
"title": "Watchlist Id"
},
"period_start": {
"type": "string",
"format": "date-time",
"title": "Period Start"
},
"period_end": {
"type": "string",
"format": "date-time",
"title": "Period End"
},
"company_count": {
"type": "integer",
"title": "Company Count"
},
"signal_count": {
"type": "integer",
"title": "Signal Count"
},
"truncated": {
"type": "boolean",
"title": "Truncated"
},
"companies": {
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array",
"title": "Companies"
}
},
"type": "object",
"required": [
"watchlist_id",
"period_start",
"period_end",
"company_count",
"signal_count",
"truncated",
"companies"
],
"title": "WeeklyReport"
} PublicTaxonomyResponse {
"properties": {
"version": {
"type": "string",
"title": "Version"
},
"root": {
"type": "string",
"title": "Root"
},
"nodes": {
"items": {
"$ref": "#/components/schemas/PublicTaxonomyNode"
},
"type": "array",
"title": "Nodes"
}
},
"type": "object",
"required": [
"version",
"root",
"nodes"
],
"title": "PublicTaxonomyResponse"
} PublicTaxonomyNode {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"parent_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Id"
},
"level": {
"type": "string",
"title": "Level"
},
"label": {
"type": "string",
"title": "Label"
}
},
"type": "object",
"required": [
"id",
"parent_id",
"level",
"label"
],
"title": "PublicTaxonomyNode"
} 