Quickstart

Choose the API that matches your Nexus account and use the host assigned to that customer.

1. Identify the customer domain

If the Nexus panel is https://example.com, use:

• https://api.example.com for Search and XML.
• https://example.com/api/v1 for Advertiser member operations.
• https://mcp.example.com/mcp for MCP.

2. Obtain the correct credential

• Search, XML, and the current MCP server use a scoped Nexus publisher API key.
• Advertiser endpoints use the authenticated member JWT or the secure same-origin session cookie.
• OpenRTB credentials and bidder endpoints are exchanged during partner onboarding.

3. Make a small read-only request

Start with a one-day report. Confirm ownership, date handling, response shape, and timezone before requesting a larger range.

curl --get "https://api.example.com/publisher/search-report" \
  --data-urlencode "token=YOUR_NEXUS_API_KEY" \
  --data-urlencode "date_from=2026-08-17" \
  --data-urlencode "date_to=2026-08-17"

4. Handle failures explicitly

Treat 401, 403, 421, 422, 429, and 5xx as distinct conditions. Do not retry authentication or validation failures in a loop.

Reports are limited to 100,000 rows. HTTP 413 means the report is too large: split the requested dates into smaller ranges rather than retrying the same request. Results are never silently truncated. HTTP 503 means a required database or report capacity is temporarily unavailable; retry with bounded exponential backoff. There can be up to 20 concurrent report queries per API process. Real API responses are not cached.

Response envelope

Nexus REST endpoints normally return:

{
  "status": "success",
  "message": "Human-readable result",
  "data": []
}

Error responses normally use the same status and message fields without sensitive internal details.