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

# Add a watched wallet address JSON Schema

> Add a watched wallet address JSON Schema contract. Includes route metadata, request parameters, response statuses, examples, and JSON fields for implementation.

Source OpenAPI: 0xArchive API 1.6.1; 168 paths; 190 component schemas.

Add a wallet so address scoped event types can report on it. Adding a wallet that is already watched changes nothing and does not count against the cap again. Hyperliquid bridge system addresses are refused, because such an address is a counterparty to every bridge movement of its token rather than an account. A plan without webhook delivery, or one already at its watched wallet cap, is refused with the reason and the way forward. Authenticate with an API key or a signed-in dashboard session. Costs no credits.

## Route Metadata

| Field                | Value                        |
| -------------------- | ---------------------------- |
| Method               | `POST`                       |
| Path                 | `/v1/webhooks/addresses`     |
| operationId          | `addWebhookWatchedAddress`   |
| Tag                  | Webhooks - Watched Addresses |
| Family               | Webhooks                     |
| Deprecated or legacy | no                           |

## Request Body

### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "addWebhookWatchedAddress request body",
  "description": "A wallet to add to your watched list.",
  "type": "object",
  "required": [
    "address"
  ],
  "properties": {
    "address": {
      "description": "A 0x prefixed 40 hex character wallet address. Stored lowercase.",
      "type": "string",
      "example": "0x6b9e773128f453f5c2c60935ee2de2cbc5390a24"
    },
    "label": {
      "description": "Your own label for the wallet. At most 64 characters.",
      "type": "string",
      "default": "",
      "example": "Desk 1"
    }
  }
}
```

## Response Contracts

### Status 200

The watched wallet address

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "addWebhookWatchedAddress response 200",
  "description": "API response containing one watched wallet address.",
  "type": "object",
  "properties": {
    "data": {
      "description": "A wallet on your watched list. Address scoped event types report only on these.",
      "type": "object",
      "required": [
        "address",
        "created_at",
        "id",
        "label"
      ],
      "properties": {
        "address": {
          "description": "The wallet, stored lowercase.",
          "type": "string",
          "example": "0x6b9e773128f453f5c2c60935ee2de2cbc5390a24"
        },
        "created_at": {
          "description": "When the wallet was added.",
          "type": "string",
          "format": "date-time"
        },
        "id": {
          "description": "Watched address identifier.",
          "type": "string",
          "format": "uuid"
        },
        "label": {
          "description": "Your own label for the wallet. At most 64 characters.",
          "type": "string",
          "example": "Desk 1"
        }
      }
    },
    "limit": {
      "description": "Watched wallets this plan allows.",
      "type": "integer",
      "format": "int64",
      "example": 15
    },
    "success": {
      "type": "boolean",
      "example": true
    }
  }
}
```

### Status 400

Invalid request

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "addWebhookWatchedAddress response 400",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 400,
  "error": "Failed to deserialize query string: limit: invalid digit found in string",
  "error_code": "invalid_query_params",
  "request_id": "3f2a9c71-5b0e-4d68-9a4c-7e1d2b6f8a05"
}
```

### Status 401

Authentication required

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "addWebhookWatchedAddress response 401",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 401,
  "error": "Missing or invalid API key. Provide X-API-Key header."
}
```

### Status 429

Rate limit exceeded

#### application/json

```json theme={"theme":"github-dark"}
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "addWebhookWatchedAddress response 429",
  "description": "Error response",
  "type": "object",
  "properties": {
    "code": {
      "description": "HTTP status code",
      "type": "integer"
    },
    "error": {
      "description": "Error message",
      "type": "string"
    },
    "error_code": {
      "description": "Machine-readable error code. Common values: `invalid_query_params` (a query parameter failed to parse or validate) and `invalid_path_params` (a path parameter failed to parse). Other endpoint-specific codes exist; treat unknown codes as generic errors of the given HTTP status.",
      "type": "string"
    },
    "request_id": {
      "description": "Unique request ID for support",
      "type": "string",
      "format": "uuid"
    }
  }
}
```

##### OpenAPI example

```json theme={"theme":"github-dark"}
{
  "code": 429,
  "error": "Rate limit exceeded"
}
```