> ## Documentation Index
> Fetch the complete documentation index at: https://docs.northaxiumdata.ca/llms.txt
> Use this file to discover all available pages before exploring further.

# Vendor Profile

> Aggregated procurement profile for a named federal contractor.

## Overview

Returns an aggregated procurement profile for a vendor — total contract value, contract count, top departments, and recent contracts. The backend attempts an exact match first, then falls back to prefix and partial-match canonicalization. Use [Browse Vendors](/api-reference/vendors/list) first to inspect likely source strings.

**Pattern:** `browse vendors` → `get vendor profile`

## Path Parameters

<ParamField path="name" type="string" required>
  Vendor name string — e.g. `Palantir Technologies Canada Inc`. Use the `vendor_key` field from the browse endpoint to construct the URL safely. Example: `Justin Trudeau`.
</ParamField>

## Query Parameters

<ParamField query="name" type="string">
  Alternative to the path parameter. When provided, this value takes precedence over the URL path segment. Use this for vendor names containing special characters (`&`, `/`, `+`) that may not survive URL path encoding reliably. For example: `GET /api/v1/vendors/_?name=SNC-Lavalin%20%26%20Associates`. Example: `Justin Trudeau`.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl -H "X-API-Key: your_api_key_here" \
    "https://api.northaxiumdata.ca/api/v1/vendors/Palantir%20Technologies%20Canada%20Inc"
  ```

  ```python Python theme={null}
  import requests

  headers = {"X-API-Key": "your_api_key_here"}
  vendor = "Palantir Technologies Canada Inc"

  response = requests.get(
      f"https://api.northaxiumdata.ca/api/v1/vendors/{vendor}",
      headers=headers
  )
  profile = response.json()["data"]
  print(f"Total value: ${profile['total_value']:,.0f}")
  print(f"Top department: {profile['departments'][0]['name']}")
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": {
      "vendor": "Palantir Technologies Canada Inc",
      "total_value": 23840000.00,
      "contract_count": 14,
      "first_contract_date": "2022-04-08",
      "last_contract_date": "2024-11-01",
      "departments": [
        {
          "name": "Royal Canadian Mounted Police | Gendarmerie royale du Canada",
          "total_value": 12500000.00,
          "contract_count": 8
        }
      ],
      "recent_contracts": [
        {
          "record_id": "abc123",
          "value": 3200000.00,
          "department": "Royal Canadian Mounted Police | Gendarmerie royale du Canada",
          "date": "2023-11-01"
        }
      ]
    }
  }
  ```

  ```json 404 theme={null}
  {
    "error": {
      "code": "NOT_FOUND",
      "message": "Vendor not found."
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": "UNAUTHORIZED",
      "message": "Missing API key. Pass your key in the X-API-Key header."
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": "RATE_LIMITED",
      "message": "Monthly request limit exceeded. Upgrade your plan for higher limits."
    }
  }
  ```
</ResponseExample>