---
search:
  tags:
    - Bots
    - POST
seo:
  description: >-
    Proves you run a bot with a Steam sign-in made as the bot, and gives you the
    bot and its… Reference for the POST /v1/bot.claim endpoint in the SteamSets
    API.
sidebar:
  label: List or claim a bot by signing in to Steam as it
  badge: POST
title: List or claim a bot by signing in to Steam as it
type: openapi-operation
---
Proves you run a bot with a Steam sign-in made as the bot, and gives you the bot and its push key. You stay signed in to Steamsets as yourself. A bot the directory already lists becomes yours as it is and stays listed; it takes your pushes once its listing fee is paid. A Steam account that is not listed becomes a new bot, pending review, and needs a name: without one the answer is 422 with an error at body.name, and the same sign-in can be sent again with the name.

`POST /v1/bot.claim`

**Request body** (`application/json`, required)

- `name` (string) — Listing name for a bot the directory does not list yet, e.g. "lvlupbot.com - legendary". Required for one; a listed bot keeps its name.
- `openid` (LoginRequestBody, required) — What Steam sent back after the owner signed in as the bot. Its return address must be /bots/claim on a Steamsets frontend.
- `type` (string) — What a bot the directory does not list yet trades. A listed bot keeps its type.

Request body example:

```json
{
  "name": "string",
  "openid": {
    "openid_assoc_handle": "123456",
    "openid_claimed_id": "76561198842603734",
    "openid_identity": "https://steamsets.com/api/v1/openid/login",
    "openid_mode": "checkid_setup",
    "openid_ns": "http://specs.openid.net/auth/2.0",
    "openid_op_endpoint": "https://steamsets.com/api/v1/openid/login",
    "openid_response_nonce": "123456",
    "openid_return_to": "https://example.com",
    "openid_sig": "123456",
    "openid_signed": "123456"
  },
  "type": "levelup"
}
```

**Responses**

- `200` — OK
- `400` — Bad Request
- `401` — Unauthorized
- `409` — Conflict
- `422` — Unprocessable Entity
- `500` — Internal Server Error

Response example, 200:

```json
{
  "apiKey": "string",
  "bot": {
    "account": {
      "animatedAvatar": "string",
      "apps": 123456,
      "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
      "avatarFrame": "string",
      "awardsGiven": 123456,
      "awardsReceived": 123456,
      "background": "string",
      "badges": 123456,
      "bans": 0,
      "city": {
        "name": "Bad Krozingen"
      },
      "country": {
        "code": "DE",
        "name": "Germany"
      },
      "createdAt": "2023-01-01T00:00:00Z",
      "donated": 123456,
      "economyBan": "steam",
      "foilBadges": 123456,
      "friends": 123456,
      "gameBans": 0,
      "level": 123456,
      "miniBackground": "string",
      "name": "steamsets",
      "nameEffect": "rainbow",
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "region": {
        "name": "Europe"
      },
      "roles": [
        {
          "extras": {
            "property1": null,
            "property2": null
          },
          "rating": 0,
          "role": "donator"
        }
      ],
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsScore": 0,
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "supporter": {
        "active": true,
        "months": 3
      },
      "themeColor": "#FF5733",
      "vacBans": 0,
      "xp": 123456
    },
    "avatarUrl": "string",
    "brand": {
      "id": "bbr_5n7dZq1rFJx3WmPa",
      "logoUrl": "string",
      "name": "string",
      "sponsored": true,
      "websiteUrl": "string"
    },
    "crypto": {
      "prices": [
        {
          "buy": "string",
          "coin": "btc",
          "sell": "0.0000038"
        }
      ]
    },
    "games": {
      "prices": {
        "cs2": {
          "buy": 0,
          "sell": 0
        },
        "gems": {
          "buy": 0,
          "sell": 0
        },
        "hydra": {
          "buy": 0,
          "sell": 0
        },
        "tf2": {
          "buy": 0,
          "sell": 0
        },
        "tod": {
          "buy": 0,
          "sell": 0
        }
      },
      "stock": {
        "copies": 0,
        "games": 0
      }
    },
    "gamesForYou": 0,
    "gems": {
      "prices": {
        "cs2": {
          "buy": 0,
          "sell": 0
        },
        "hydra": {
          "buy": 0,
          "sell": 0
        },
        "tf2": {
          "buy": 0,
          "sell": 0
        },
        "tod": {
          "buy": 0,
          "sell": 0
        }
      },
      "stock": 0
    },
    "id": "bot_3cVFAKxh8Q2ZqkTq",
    "keys": {
      "cs2": 0,
      "hydra": 0,
      "tf2": 0,
      "tod": 0
    },
    "listing": {
      "createdAt": "2019-08-24T14:15:22Z",
      "listingFeePaid": true,
      "ownerVerified": true,
      "status": "pending"
    },
    "name": "lvlupbot.com - legendary",
    "owner": {
      "animatedAvatar": "string",
      "apps": 123456,
      "avatar": "f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9",
      "avatarFrame": "string",
      "awardsGiven": 123456,
      "awardsReceived": 123456,
      "background": "string",
      "badges": 123456,
      "bans": 0,
      "city": {
        "name": "Bad Krozingen"
      },
      "country": {
        "code": "DE",
        "name": "Germany"
      },
      "createdAt": "2023-01-01T00:00:00Z",
      "donated": 123456,
      "economyBan": "steam",
      "foilBadges": 123456,
      "friends": 123456,
      "gameBans": 0,
      "level": 123456,
      "miniBackground": "string",
      "name": "steamsets",
      "nameEffect": "rainbow",
      "normalBadges": 123456,
      "playtime": 123456,
      "pointsGiven": 123456,
      "pointsReceived": 123456,
      "privacy": "public",
      "region": {
        "name": "Europe"
      },
      "roles": [
        {
          "extras": {
            "property1": null,
            "property2": null
          },
          "rating": 0,
          "role": "donator"
        }
      ],
      "state": {
        "name": "Baden-Wurttemberg"
      },
      "steamId": "76561198842603734",
      "steamSetsScore": 0,
      "steamSetsVanity": "steamsets",
      "steamVanity": "steamsets",
      "supporter": {
        "active": true,
        "months": 3
      },
      "themeColor": "#FF5733",
      "vacBans": 0,
      "xp": 123456
    },
    "sets": {
      "limits": {
        "maxPerApp": 0
      },
      "prices": {
        "cs2": {
          "buy": 0,
          "sell": 0
        },
        "gems": {
          "buy": 0,
          "sell": 0
        },
        "hydra": {
          "buy": 0,
          "sell": 0
        },
        "tf2": {
          "buy": 0,
          "sell": 0
        },
        "tod": {
          "buy": 0,
          "sell": 0
        }
      },
      "stock": {
        "apps": 0,
        "foil": 0,
        "maxLevel": 0,
        "normal": 0
      }
    },
    "setsForYou": 0,
    "source": "push",
    "status": {
      "online": true,
      "stale": true,
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "type": "levelup"
  },
  "listingFee": {
    "keys": 0,
    "tradeUrl": "string"
  }
}
```