Get the live progress of an account's most recent update.

POST/v1/account.updateProgress

Authorization

AuthorizationBearer token · headerrequired

Request body

requiredapplication/json

idIDSearch

Show properties

accountIdinteger<int32>

Account ID to search for

min 0 · min length 7

steamId64string

SteamID64 to search for

min length 17 · max length 17

vanityVanitySearch

Show properties

typestringrequired

Which type of vanity to search for

Allowed:steaminternal

valuestringrequired

Vanity to search for

min length 2 · matches ^[a-zA-Z0-9-_]+$

Responses

200

progressUpdateProgress

The account's current update progress. Absent if there is none to show.

Show properties

accountIdinteger<int32>required

The account this progress snapshot belongs to.

min 0

currentStepstringrequired

The step the update is on now.

errorUpdateError

Set when the update failed. Omitted otherwise.

Show properties

categorystringrequired

The reason the update failed.

retryablebooleanrequired

True if retrying the update now may succeed.

finishedAtstring<date-time>

The time the update finished, in UTC. Set on success or failure.

percentinteger<int32>required

How far the update has progressed, from 0 to 100.

min 0

queuePositioninteger<int64>

Reserved for a future queue that can report a position. Always absent today.

queuedAtstring<date-time>

The time the update was queued, in UTC.

runIdstringrequired

An ID for the update run. Compare it to tell a new run from a later event of the same run.

startedAtstring<date-time>

The time the update started running, in UTC.

statusstringrequired

The overall status: undefined, pending, in_progress, completed, or failed. A completed run can still list a skipped or failed step: the data was saved, and that step kept the existing data.

stepsUpdateStep[] | nullrequired

Every step in the pipeline, in run order, with its own status.

Show properties

Array of UpdateStep

finishedAtstring<date-time>

The time this step finished, in UTC.

namestringrequired

The pipeline step this row describes.

reasonstring

Why the step ended skipped or failed: private (Steam privacy settings hide the data), unavailable (the step failed after its retries), or not_run (the run stopped before this step). Absent for a step that is pending, running, or done.

startedAtstring<date-time>

The time this step started, in UTC.

statusstringrequired

The step's state: pending, running, done, skipped, or failed.

updatedAtstring<date-time>required

The time this snapshot was last written, in UTC.

400

Bad Request

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

401

Unauthorized

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

404

Not Found

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

422

Unprocessable Entity

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

500

Internal Server Error

detailstring

A human-readable explanation specific to this occurrence of the problem.

errorsErrorDetail[] | null

Optional list of individual error details

Show properties

Array of ErrorDetail

locationstring

Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id'

messagestring

Error message text

valueany

The value at the given location

instancestring<uri>

A URI reference that identifies the specific occurrence of the problem.

statusinteger<int64>

HTTP status code

titlestring

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestring<uri>

A URI reference to human-readable documentation for the error.

default: "about:blank"

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.steamsets.com/v1/account.updateProgress' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": {
    "accountId": 0,
    "steamId64": "stringstringstrin"
  },
  "vanity": {
    "type": "steam",
    "value": "string"
  }
}'

const response = await fetch("https://api.steamsets.com/v1/account.updateProgress", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"id\": {\n    \"accountId\": 0,\n    \"steamId64\": \"stringstringstrin\"\n  },\n  \"vanity\": {\n    \"type\": \"steam\",\n    \"value\": \"string\"\n  }\n}"
});

import requests

response = requests.post(
    "https://api.steamsets.com/v1/account.updateProgress",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"id\": {\n    \"accountId\": 0,\n    \"steamId64\": \"stringstringstrin\"\n  },\n  \"vanity\": {\n    \"type\": \"steam\",\n    \"value\": \"string\"\n  }\n}",
)

Response

{
  "progress": {
    "accountId": 0,
    "currentStep": "string",
    "error": {
      "category": "rate_limited",
      "retryable": true
    },
    "finishedAt": "2019-08-24T14:15:22Z",
    "percent": 0,
    "queuePosition": 0,
    "queuedAt": "2019-08-24T14:15:22Z",
    "runId": "string",
    "startedAt": "2019-08-24T14:15:22Z",
    "status": "in_progress",
    "steps": [
      {
        "finishedAt": "2019-08-24T14:15:22Z",
        "name": "badges",
        "reason": "private",
        "startedAt": "2019-08-24T14:15:22Z",
        "status": "done"
      }
    ],
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}

{
  "detail": "Property foo is required but is missing.",
  "errors": [
    {
      "location": "string",
      "message": "string",
      "value": null
    }
  ],
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "https://example.com/errors/example"
}