> ## 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.

# Grant Recipients

> Retrieve generalized profiles and funding histories for grant recipients.

Get a list of organizations, municipalities, and institutions that have received federal grants or contributions.

### Query Parameters

<ParamField query="limit" type="integer" default="100">
  Maximum number of recipients to return. Default: `20`. Max: `200`. Example: `25`.
</ParamField>

<ParamField query="offset" type="integer" default="0">
  Number of records to skip for pagination. Example: `50`.
</ParamField>

<ParamField query="q" type="string" required>
  Partial match on recipient name. Example: `University of Toronto`.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.northaxiumdata.ca/api/v1/grants/recipients?q=University&limit=10" \
    -H "X-API-Key: <your-api-key>"
  ```

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

  url = "https://api.northaxiumdata.ca/api/v1/grants/recipients"
  headers = {"X-API-Key": "<your-api-key>"}
  params = {
      "q": "University",
      "limit": 10
  }

  response = requests.get(url, headers=headers, params=params)
  print(response.json())
  ```

  ```javascript Node.js theme={null}
  const fetch = require('node-fetch');

  const url = new URL('https://api.northaxiumdata.ca/api/v1/grants/recipients');
  url.search = new URLSearchParams({
    q: 'University',
    limit: '10'
  });

  fetch(url, {
    headers: {
      'X-API-Key': '<your-api-key>'
    }
  })
    .then(res => res.json())
    .then(json => console.log(json));
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": [
      {
        "recipient": "University of Toronto",
        "grant_count": 8421,
        "total_value": 128500000.00
      }
    ],
    "meta": {
      "total": 1,
      "limit": 10,
      "offset": 0
    }
  }
  ```

  ```json 400 theme={null}
  {
    "error": {
      "code": "BAD_REQUEST",
      "message": "Invalid parameter value."
    }
  }
  ```

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

  ```json 404 theme={null}
  {
    "error": {
      "code": "NOT_FOUND",
      "message": "The requested resource was not found."
    }
  }
  ```

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