---
title: "The risk-label taxonomy"
method: GET
path: "/v1/risk-labels"
tags: ["Reference"]
---

# The risk-label taxonomy

`GET /v1/risk-labels`

## Request

- Base URL: `https://intelapi.publicaml.org`
- URL: `https://intelapi.publicaml.org/v1/risk-labels`
- Auth: one of:
  - API key in header `X-API-Key`
  - none

Every risk label the API can attach to an address, its aliases, its category and its score. This is the vocabulary POST /v1/incidents validates against — read it before pushing.

`source` says where the catalogue came from: 'postgres' is the authority, 'builtin' is the copy compiled into the image and means the API is degraded.

## Query parameters

- `category` string

## Response `200`

The taxonomy.

- object
  - `labels` object[]
    - `label_id` integer
    - `label` string
    - `aliases` string[]
    - `category` string
    - `category_name` string
    - `risk_score` number
  - `categories` object[]
  - `total` integer
  - `source` 'postgres' | 'builtin'

## Other responses

- `400`: Malformed request.
- `429`: Rate limited: anonymous callers, and keys issued with a quota of their own. Authenticate to remove the limit.
- `500`: Server error.

---

[API](https://skmtc.dev/publicaml/apis/publicaml-intelligence-api.md) · [All operations](https://skmtc.dev/publicaml/apis/publicaml-intelligence-api/llms.txt) · [OpenAPI document](https://skmtc.dev/publicaml/apis/publicaml-intelligence-api/revisions/7c0c6315088c?raw)