# getRecipientProfile

**Identifier:** `usaspending_getRecipientProfile`

**Provider:** [USAspending](https://kirha.com/providers/usaspending.md)

Profile of a US federal award recipient by recipientId or UEI: legal and alternate names, address, business types (small business, women-owned, nonprofit...), parent company, subsidiaries with their amounts, and total federal obligations over the chosen period. Use it to size a company's federal business or map its corporate family.

## Run it with the CLI

```bash
kirha tools run usaspending_getRecipientProfile \
  --input '{}'
```

`--input` takes a JSON object that matches the input schema. Pass `--input -` to read it from stdin.

## Call it over HTTP

```bash
curl https://api.kirha.com/tools/v1/execute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: **********' \
  --data '{
  "tool_name": "usaspending_getRecipientProfile",
  "input": {}
}'
```

Replace the stars with an API key from https://app.kirha.com/api-keys.

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "period": {
      "default": "all",
      "description": "all (since FY2008), latest (trailing 12 months) or a fiscal year, e.g., 2025",
      "pattern": "^(all|latest|\\d{4})$",
      "type": "string"
    },
    "recipientId": {
      "description": "USAspending recipient ID (hash ending in -P parent, -C child or -R recipient), from searchRecipients",
      "pattern": "^[0-9a-f-]{36}-[PCR]$",
      "type": "string"
    },
    "uei": {
      "description": "12-character SAM Unique Entity ID, e.g., FSY4LVSBGWB7",
      "pattern": "^[A-Za-z0-9]{12}$",
      "type": "string"
    }
  },
  "type": "object"
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "additionalProperties": false,
  "properties": {
    "address": {
      "type": "string"
    },
    "alternateNames": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "businessTypes": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "childRecipientIds": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "children": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "amountUsd": {
            "type": "number"
          },
          "name": {
            "type": "string"
          },
          "recipientId": {
            "type": "string"
          },
          "state": {
            "type": "string"
          },
          "uei": {
            "type": "string"
          }
        },
        "required": [
          "recipientId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "congressionalDistrict": {
      "type": "string"
    },
    "context": {
      "type": "string"
    },
    "duns": {
      "type": "string"
    },
    "level": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "parents": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "name": {
            "type": "string"
          },
          "recipientId": {
            "type": "string"
          },
          "uei": {
            "type": "string"
          }
        },
        "required": [
          "recipientId"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "recipientId": {
      "type": "string"
    },
    "totalLoanFaceValueUsd": {
      "type": "number"
    },
    "totalObligationsUsd": {
      "type": "number"
    },
    "totalTransactions": {
      "type": "number"
    },
    "uei": {
      "type": "string"
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "context",
    "recipientId",
    "url",
    "alternateNames",
    "level",
    "businessTypes",
    "parents",
    "children",
    "childRecipientIds"
  ],
  "type": "object"
}
```

## Related tools

Other USAspending tools that this tool refers to, or that refer to it.

- [`searchRecipients`](https://kirha.com/providers/usaspending/searchRecipients.md)

-----

[All USAspending tools](https://kirha.com/providers/usaspending.md) · [< Back to tools list](https://kirha.com/tools.md)