Sign in

v4

latestOpenAPI 3.1.02026-07-3196251302.5 KB
account

Get account settings

post/v1/account.getSettings

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

countryOverrideCodestring nullable

The code of the override country

countryOverrideNamestring nullable

The name of the override country

emailstring email required

The email the account is using

emailVerifiedAtstring date-time nullable required

The time the email was verified

hiddenboolean required

Whether the account is hidden in the leaderboards

languagestring required

The language the account is using

privacy'public' | 'private' | 'friends_only' required

The privacy of the account

subscribedboolean required

Whether the account is subscribed to marketing emails

vanitystring required

The vanity the account is using

Example response

{
  "$schema": "https://api.steamsets.com/schemas/V1AccountGetSettingsBody.json",
  "analytics": {
    "last24Hours": {
      "failedRequests": 358,
      "outcomeBreakdown": [
        {
          "count": 9876,
          "outcome": "VALID"
        }
      ],
      "successRate": 96.5,
      "successfulRequests": 9876,
      "totalRequests": 10234
    },
    "timeSeries": {
      "hourly": [
        {
          "count": 423,
          "outcome": "VALID",
          "time": "2024-01-15T00:00:00.000Z"
        }
      ]
    }
  },
  "chosenRole": {
    "tier": "tier_1"
  },
  "connections": [
    {
      "avatar": "https://cdn.cloudflare.steamstatic.com/steamcommunity/public/images/avatars/f1/f1a1d2c3d0c9d1e1f2f3f4f5f6f7f8f9.jpg",
      "connectionId": "123456",
      "externalId": "123456",
      "failed": true,
      "hide": true,
      "name": "steamsets",
      "provider": "discord",
      "verified": true
    }
  ],
  "developerApps": [
    {
      "analytics": {
        "last24Hours": {
          "failedRequests": 358,
          "outcomeBreakdown": [
            {
              "count": 9876,
              "outcome": "VALID"
            }
          ],
          "successRate": 96.5,
          "successfulRequests": 9876,
          "totalRequests": 10234
        },
        "timeSeries": {
          "hourly": [
            {
              "count": 423,
              "outcome": "VALID",
              "time": "2024-01-15T00:00:00.000Z"
            }
          ]
        }
      },
      "apiKey": "null",
      "createdAt": "2023-01-01T00:00:00Z",
      "description": "My App Description",
      "environment": "production",
      "id": "key_123456",
      "keyId": "key_123456",
      "name": "My App"
    }
  ],
  "email": "steamsets@example.com",
  "emailVerifiedAt": "2023-01-01T00:00:00Z",
  "hidden": true,
  "language": "en",
  "privacy": "public",
  "sessions": [
    {
      "createdAt": "2023-01-01T00:00:00Z",
      "expiresAt": "2023-01-01T00:00:00Z",
      "ip": "127.0.0.1",
      "lastSeen": "2023-01-01T00:00:00Z",
      "sessionId": "123456",
      "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36"
    }
  ],
  "vanity": "flo"
}