{ "openapi": "3.1.0", "info": { "title": "Goldmine API", "version": "v1", "description": "Programmatic access to the Goldmine platform for automated CS2 skin trading. Endpoints are workspace scoped and called over ConnectRPC with JSON request and response bodies." }, "tags": [ { "name": "API Keys" }, { "name": "Account Groups" }, { "name": "Account Linking" }, { "name": "Accounts" }, { "name": "Assignments" }, { "name": "Chat" }, { "name": "Confirmations" }, { "name": "Contract Evaluation" }, { "name": "Contracts" }, { "name": "Credentials" }, { "name": "Filter Sets" }, { "name": "Friends" }, { "name": "Import" }, { "name": "Intents" }, { "name": "Inventory" }, { "name": "Inventory Changes" }, { "name": "Market Observations" }, { "name": "Memberships" }, { "name": "Passkeys" }, { "name": "Permissions" }, { "name": "Pools" }, { "name": "Pricing" }, { "name": "Profit and Loss" }, { "name": "Providers" }, { "name": "Purchases" }, { "name": "Remediations" }, { "name": "Renewals" }, { "name": "Sessions" }, { "name": "Snapshots" }, { "name": "Trade Offers" }, { "name": "Transitions" }, { "name": "Two-Factor" }, { "name": "Usage" }, { "name": "Users" }, { "name": "Workspace Keys" }, { "name": "Workspaces" } ], "paths": { "/accounts.v1.Accounts/AcceptMembership": { "post": { "operationId": "accounts.v1.Accounts.AcceptMembership", "summary": "Accept a workspace invitation", "description": "Accepts a pending workspace invitation, activating the caller's membership and granting its operational policies.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.AcceptMembershipRequest" }, "examples": { "accept_membership": { "summary": "Accept a workspace invitation", "value": { "membershipId": "ICEiIyQlJicoKSorLC0uLw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.AcceptMembershipResponse" }, "examples": { "accept_membership": { "summary": "Accept a workspace invitation", "value": { "membership": { "id": "ICEiIyQlJicoKSorLC0uLw==", "userId": "q83vq83vEjRWeBI0VniQqg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "role": "MEMBERSHIP_ROLE_MEMBER", "status": "MEMBERSHIP_STATUS_ACCEPTED", "createdAt": "2026-06-29T12:00:00Z", "updatedAt": "2026-06-29T12:10:00Z", "policies": [ "trading", "analytics" ] } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/AddEmailCredential": { "post": { "operationId": "accounts.v1.Accounts.AddEmailCredential", "summary": "Add an email and password sign-in", "description": "Adds an email and password credential to an account that currently signs in only through Discord, so the user can also sign in with a password.", "tags": [ "Account Linking" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.AddEmailCredentialRequest" }, "examples": { "add_email_credential": { "summary": "Add an email and password sign-in", "value": { "email": "jordan@acme.example", "password": "correct-horse-battery-staple", "turnstileToken": "0.cf-turnstile-response-token" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.AddEmailCredentialResponse" }, "examples": { "add_email_credential": { "summary": "Add an email and password sign-in", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/BeginPasskeyRegistration": { "post": { "operationId": "accounts.v1.Accounts.BeginPasskeyRegistration", "summary": "Begin passkey registration", "description": "Starts enrolling a new passkey for the signed-in user. Returns the WebAuthn creation options the browser passes to the authenticator.", "tags": [ "Passkeys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.BeginPasskeyRegistrationRequest" }, "examples": { "begin_passkey_registration": { "summary": "Begin passkey registration", "value": { "name": "MacBook Touch ID" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.BeginPasskeyRegistrationResponse" }, "examples": { "begin_passkey_registration": { "summary": "Begin passkey registration", "value": { "options": "eyJwdWJsaWNLZXkiOnsiY2hhbGxlbmdlIjoiWVdKalpHVm1aMmhwYWciLCJycCI6eyJuYW1lIjoiR29sZG1pbmUifX19" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/BeginStepUp": { "post": { "operationId": "accounts.v1.Accounts.BeginStepUp", "summary": "Begin a step-up re-verification", "description": "Starts a fresh two-factor re-verification for the signed-in user ahead of a sensitive action. Returns a challenge ID and the methods available to complete it.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.BeginStepUpRequest" }, "examples": { "begin_step_up": { "summary": "Begin a step-up re-verification", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.BeginStepUpResponse" }, "examples": { "begin_step_up": { "summary": "Begin a step-up re-verification", "value": { "challengeId": "chl_8f3a2b1c9d4e", "allowedMethods": [ "TWO_FACTOR_METHOD_EMAIL", "TWO_FACTOR_METHOD_TOTP" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ChangeEmail": { "post": { "operationId": "accounts.v1.Accounts.ChangeEmail", "summary": "Change the account email address", "description": "Changes the signed-in user's email address. The caller must supply their current password to authorize the change.", "tags": [ "Credentials" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ChangeEmailRequest" }, "examples": { "change_email": { "summary": "Change the account email address", "value": { "newEmail": "jordan.hale@acme.example", "password": "correct-horse-battery-staple" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ChangeEmailResponse" }, "examples": { "change_email": { "summary": "Change the account email address", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ChangePassword": { "post": { "operationId": "accounts.v1.Accounts.ChangePassword", "summary": "Change the account password", "description": "Changes the signed-in user's password. The caller must supply their current password to authorize the change.", "tags": [ "Credentials" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ChangePasswordRequest" }, "examples": { "change_password": { "summary": "Change the account password", "value": { "currentPassword": "old-passphrase-2025", "newPassword": "correct-horse-battery-staple" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ChangePasswordResponse" }, "examples": { "change_password": { "summary": "Change the account password", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/CountAPIKeys": { "post": { "operationId": "accounts.v1.Accounts.CountAPIKeys", "summary": "Count workspace API keys", "description": "Returns the number of API keys in the workspace. Drives the API keys page's count badge without loading and counting every key.", "tags": [ "API Keys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CountAPIKeysRequest" }, "examples": { "count_a_p_i_keys": { "summary": "Count API keys in the workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CountAPIKeysResponse" }, "examples": { "count_a_p_i_keys": { "summary": "Count API keys in the workspace", "value": { "count": 3 } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/CountMemberships": { "post": { "operationId": "accounts.v1.Accounts.CountMemberships", "summary": "Count memberships by status", "description": "Returns the number of memberships in each status, optionally filtered to a single workspace or user. Drives status-tab counts (Invited, Accepted) without loading every membership.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CountMembershipsRequest" }, "examples": { "count_memberships_by_user": { "summary": "Count every membership held by a user across workspaces", "value": { "userId": "EjRWeBI0VniQEjRWeBI0Vg==" } }, "count_memberships_by_workspace": { "summary": "Count every membership in a workspace by status", "value": { "workspaceId": "AAECAwQFBgcICQoLDA0ODw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CountMembershipsResponse" }, "examples": { "count_memberships_by_user": { "summary": "Count every membership held by a user across workspaces", "value": { "counts": [ { "status": "MEMBERSHIP_STATUS_ACCEPTED", "count": 3 } ] } }, "count_memberships_by_workspace": { "summary": "Count every membership in a workspace by status", "value": { "counts": [ { "status": "MEMBERSHIP_STATUS_INVITED", "count": 2 }, { "status": "MEMBERSHIP_STATUS_ACCEPTED", "count": 8 } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/CreateAPIKey": { "post": { "operationId": "accounts.v1.Accounts.CreateAPIKey", "summary": "Create a workspace API key", "description": "Creates an API key scoped to a workspace with the given policies and optional expiry. The full key is returned only once at creation and must be stored immediately. A recent two-factor re-verification is required.", "tags": [ "API Keys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateAPIKeyRequest" }, "examples": { "create_a_p_i_key": { "summary": "Create a workspace API key", "value": { "name": "CI deploy key", "expiresAt": "2027-06-29T00:00:00Z", "policies": [ "trading", "analytics" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateAPIKeyResponse" }, "examples": { "create_a_p_i_key": { "summary": "Create a workspace API key", "value": { "apiKey": { "id": "CgsMDQ4PEBESExQVFhcYGQ==", "name": "CI deploy key", "keyPrefix": "gm_live_8f3a", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "expiresAt": "2027-06-29T00:00:00Z", "createdAt": "2026-06-29T12:00:00Z", "policies": [ "trading", "analytics" ] }, "rawKey": "gm_live_8f3a2b1c9d4e5f60718293a4b5c6d7e8" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/CreateMembership": { "post": { "operationId": "accounts.v1.Accounts.CreateMembership", "summary": "Invite a user to a workspace", "description": "Creates a membership inviting a user to a workspace with the given initial operational policies. The invitation always creates a member-role membership; ownership cannot be granted through an invite. The invited user must accept before the membership becomes active.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateMembershipRequest" }, "examples": { "create_membership": { "summary": "Invite a user to a workspace", "value": { "userId": "q83vq83vEjRWeBI0VniQqg==", "policies": [ "trading", "analytics" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateMembershipResponse" }, "examples": { "create_membership": { "summary": "Invite a user to a workspace", "value": { "membership": { "id": "ICEiIyQlJicoKSorLC0uLw==", "userId": "q83vq83vEjRWeBI0VniQqg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "role": "MEMBERSHIP_ROLE_MEMBER", "status": "MEMBERSHIP_STATUS_INVITED", "createdAt": "2026-06-29T12:00:00Z", "updatedAt": "2026-06-29T12:00:00Z", "policies": [ "trading", "analytics" ] } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/CreateUser": { "post": { "operationId": "accounts.v1.Accounts.CreateUser", "summary": "Create a user", "description": "Creates a new user account with the given display name and email address.", "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateUserRequest" }, "examples": { "create_user": { "summary": "Create a user", "value": { "name": "Morgan Reyes", "email": "morgan@acme.example" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateUserResponse" }, "examples": { "create_user": { "summary": "Create a user", "value": { "user": { "id": "q83vq83vEjRWeBI0VniQqg==", "name": "Morgan Reyes", "email": "morgan@acme.example", "status": "active", "createdAt": "2026-06-29T12:00:00Z", "updatedAt": "2026-06-29T12:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/CreateWorkspace": { "post": { "operationId": "accounts.v1.Accounts.CreateWorkspace", "summary": "Create a workspace", "description": "Creates a new workspace. The caller becomes the workspace owner.", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateWorkspaceRequest" }, "examples": { "create_workspace": { "summary": "Create a workspace", "value": { "name": "Redline Flips", "description": "Knife and glove flipping desk." } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.CreateWorkspaceResponse" }, "examples": { "create_workspace": { "summary": "Create a workspace", "value": { "workspace": { "id": "9HrBC1jMQ3KlZw4CssPUeQ==", "name": "Redline Flips", "description": "Knife and glove flipping desk.", "createdAt": "2026-06-29T12:00:00Z", "updatedAt": "2026-06-29T12:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/DeclineMembership": { "post": { "operationId": "accounts.v1.Accounts.DeclineMembership", "summary": "Decline a workspace invitation", "description": "Declines a pending workspace invitation. The membership is removed and no access is granted.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeclineMembershipRequest" }, "examples": { "decline_membership": { "summary": "Decline a workspace invitation", "value": { "membershipId": "ICEiIyQlJicoKSorLC0uLw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeclineMembershipResponse" }, "examples": { "decline_membership": { "summary": "Decline a workspace invitation", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/DeleteAPIKey": { "post": { "operationId": "accounts.v1.Accounts.DeleteAPIKey", "summary": "Delete an API key", "description": "Permanently revokes an API key. Requests authenticated with that key stop working immediately.", "tags": [ "API Keys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeleteAPIKeyRequest" }, "examples": { "delete_a_p_i_key": { "summary": "Delete an API key", "value": { "apiKeyId": "CgsMDQ4PEBESExQVFhcYGQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeleteAPIKeyResponse" }, "examples": { "delete_a_p_i_key": { "summary": "Delete an API key", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/DeleteMembership": { "post": { "operationId": "accounts.v1.Accounts.DeleteMembership", "summary": "Remove a member from a workspace", "description": "Removes a membership, revoking the member's access to the workspace.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeleteMembershipRequest" }, "examples": { "delete_membership": { "summary": "Remove a member from a workspace", "value": { "membershipId": "ICEiIyQlJicoKSorLC0uLw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeleteMembershipResponse" }, "examples": { "delete_membership": { "summary": "Remove a member from a workspace", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/DeletePasskey": { "post": { "operationId": "accounts.v1.Accounts.DeletePasskey", "summary": "Delete a passkey", "description": "Removes an enrolled passkey from the account. When two-factor is enabled the caller must also supply their password and a current authenticator code to confirm.", "tags": [ "Passkeys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeletePasskeyRequest" }, "examples": { "delete_passkey": { "summary": "Delete a passkey", "value": { "passkeyId": "GhscHR4fICEiIyQlJicoKQ==", "password": "correct-horse-battery-staple", "totpCode": "123456" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeletePasskeyResponse" }, "examples": { "delete_passkey": { "summary": "Delete a passkey", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/DeleteWorkspace": { "post": { "operationId": "accounts.v1.Accounts.DeleteWorkspace", "summary": "Delete a workspace", "description": "Soft-deletes a workspace. The workspace and its data are kept for a recovery window before they are permanently removed.", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeleteWorkspaceRequest" }, "examples": { "delete_workspace": { "summary": "Delete a workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DeleteWorkspaceResponse" }, "examples": { "delete_workspace": { "summary": "Delete a workspace", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/DisableTOTP": { "post": { "operationId": "accounts.v1.Accounts.DisableTOTP", "summary": "Disable the authenticator app", "description": "Removes the enrolled authenticator app from the account. The caller must supply their password and a current authenticator or backup code to confirm.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DisableTOTPRequest" }, "examples": { "disable_t_o_t_p": { "summary": "Disable the authenticator app", "value": { "password": "correct-horse-battery-staple", "totpCode": "123456" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.DisableTOTPResponse" }, "examples": { "disable_t_o_t_p": { "summary": "Disable the authenticator app", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/FinishPasskeyRegistration": { "post": { "operationId": "accounts.v1.Accounts.FinishPasskeyRegistration", "summary": "Complete passkey registration", "description": "Completes passkey enrollment by submitting the authenticator's attestation. Returns the newly registered passkey.", "tags": [ "Passkeys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.FinishPasskeyRegistrationRequest" }, "examples": { "finish_passkey_registration": { "summary": "Complete passkey registration", "value": { "attestation": "eyJpZCI6ImFiYzEyMyIsInJhd0lkIjoiYWJjMTIzIiwidHlwZSI6InB1YmxpYy1rZXkifQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.FinishPasskeyRegistrationResponse" }, "examples": { "finish_passkey_registration": { "summary": "Complete passkey registration", "value": { "passkey": { "id": "GhscHR4fICEiIyQlJicoKQ==", "name": "MacBook Touch ID", "createdAt": "2026-06-29T12:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetMembership": { "post": { "operationId": "accounts.v1.Accounts.GetMembership", "summary": "Fetch a single membership by ID", "description": "Returns the membership identified by the given ID, including the member's role, invitation status, and granted operational policies.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetMembershipRequest" }, "examples": { "get_membership": { "summary": "Fetch a single membership by ID", "value": { "membershipId": "VniQq83vEjRWeBI0VniQqw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetMembershipResponse" }, "examples": { "get_membership": { "summary": "Fetch a single membership by ID", "value": { "membership": { "id": "VniQq83vEjRWeBI0VniQqw==", "userId": "EjRWeBI0VniQEjRWeBI0Vg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "role": "MEMBERSHIP_ROLE_MEMBER", "status": "MEMBERSHIP_STATUS_ACCEPTED", "createdAt": "2026-02-01T09:00:00Z", "updatedAt": "2026-02-01T09:30:00Z", "policies": [ "trading", "steam" ] } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetMemberships": { "post": { "operationId": "accounts.v1.Accounts.GetMemberships", "summary": "Fetch multiple memberships by ID", "description": "Returns the memberships for a list of IDs in a single call. IDs that do not match a membership are reported separately.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetMembershipsRequest" }, "examples": { "get_memberships": { "summary": "Fetch multiple memberships by ID", "value": { "membershipIds": [ "VniQq83vEjRWeBI0VniQqw==", "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetMembershipsResponse" }, "examples": { "get_memberships": { "summary": "Fetch multiple memberships by ID", "value": { "memberships": [ { "id": "VniQq83vEjRWeBI0VniQqw==", "userId": "EjRWeBI0VniQEjRWeBI0Vg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "role": "MEMBERSHIP_ROLE_OWNER", "status": "MEMBERSHIP_STATUS_ACCEPTED", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-01-15T10:00:00Z" } ], "notFoundIds": [ "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetMyPermissions": { "post": { "operationId": "accounts.v1.Accounts.GetMyPermissions", "summary": "Get the caller's permissions", "description": "Returns the signed-in caller's role, granted policies, and the resolved set of permissions in the current workspace.", "tags": [ "Permissions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetMyPermissionsRequest" }, "examples": { "get_my_permissions": { "summary": "Get the caller's permissions", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetMyPermissionsResponse" }, "examples": { "get_my_permissions": { "summary": "Get the caller's permissions", "value": { "role": "owner", "policies": [ "trading", "steam", "proxies", "analytics" ], "permissions": [ "PERMISSION_VIEW_WORKSPACE_SETTINGS", "PERMISSION_MANAGE_WORKSPACE_SETTINGS", "PERMISSION_VIEW_CONTRACTS", "PERMISSION_MANAGE_CONTRACTS" ], "isAdministrator": false } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetTwoFactorStatus": { "post": { "operationId": "accounts.v1.Accounts.GetTwoFactorStatus", "summary": "Get two-factor status", "description": "Returns the caller's two-factor configuration, including the active method, which methods are enrolled or available, and how many backup codes remain.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetTwoFactorStatusRequest" }, "examples": { "get_two_factor_status": { "summary": "Get two-factor status", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetTwoFactorStatusResponse" }, "examples": { "get_two_factor_status": { "summary": "Get two-factor status", "value": { "activeMethod": "TWO_FACTOR_METHOD_TOTP", "totpEnrolled": true, "passkeyEnrolled": false, "emailAvailable": true, "backupCodesRemaining": 7 } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetUser": { "post": { "operationId": "accounts.v1.Accounts.GetUser", "summary": "Fetch a single user by ID", "description": "Returns the user account identified by the given ID, including display name, email, and account status.", "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetUserRequest" }, "examples": { "get_user": { "summary": "Fetch a single user by ID", "value": { "userId": "EjRWeBI0VniQEjRWeBI0Vg==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetUserResponse" }, "examples": { "get_user": { "summary": "Fetch a single user by ID", "value": { "user": { "id": "EjRWeBI0VniQEjRWeBI0Vg==", "name": "Jordan Hale", "email": "jordan@acme.example", "status": "active", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-03-02T14:22:30Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetUserByEmail": { "post": { "operationId": "accounts.v1.Accounts.GetUserByEmail", "summary": "Resolve a registered user by email", "description": "Looks up a registered user by their exact email address, so a workspace owner can resolve an invitee's email to a user ID before calling CreateMembership. Matches only an existing, exact email - never a partial or fuzzy match.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetUserByEmailRequest" }, "examples": { "get_user_by_email": { "summary": "Resolve a registered user by email", "value": { "email": "jordan@acme.example" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetUserByEmailResponse" }, "examples": { "get_user_by_email": { "summary": "Resolve a registered user by email", "value": { "user": { "id": "EjRWeBI0VniQEjRWeBI0Vg==", "name": "Jordan Hale", "email": "jordan@acme.example", "status": "active", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-03-02T14:22:30Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetUsers": { "post": { "operationId": "accounts.v1.Accounts.GetUsers", "summary": "Fetch multiple users by ID", "description": "Returns the user accounts for a list of IDs in a single call. IDs that do not match a user are reported separately so the caller can tell which were missing.", "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetUsersRequest" }, "examples": { "get_users": { "summary": "Fetch multiple users by ID", "value": { "userIds": [ "EjRWeBI0VniQEjRWeBI0Vg==", "q83vq83vEjRWeBI0VniQqg==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetUsersResponse" }, "examples": { "get_users": { "summary": "Fetch multiple users by ID", "value": { "users": [ { "id": "EjRWeBI0VniQEjRWeBI0Vg==", "name": "Jordan Hale", "email": "jordan@acme.example", "status": "active", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-03-02T14:22:30Z" } ], "notFoundIds": [ "q83vq83vEjRWeBI0VniQqg==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetWorkspace": { "post": { "operationId": "accounts.v1.Accounts.GetWorkspace", "summary": "Fetch the caller's active workspace", "description": "Returns the workspace record for the caller's active workspace (the one authorized by the session or API key). There is no workspace_id request field; a caller cannot fetch a workspace it does not belong to.", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetWorkspaceRequest" }, "examples": { "fetch_active_workspace": { "summary": "Fetch a workspace the caller is a member of", "value": {} }, "fetch_newly_created_workspace": { "summary": "Fetch a freshly created workspace with no description set", "value": {} }, "fetch_soft_deleted_workspace": { "summary": "Fetch a soft-deleted workspace within the retention window", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetWorkspaceResponse" }, "examples": { "fetch_active_workspace": { "summary": "Fetch a workspace the caller is a member of", "value": { "workspace": { "id": "AAECAwQFBgcICQoLDA0ODw==", "name": "Acme Trading", "description": "Primary trading workspace.", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-03-02T14:22:30Z" } } }, "fetch_newly_created_workspace": { "summary": "Fetch a freshly created workspace with no description set", "value": { "workspace": { "id": "9HrBC1jMQ3KlZw4CssPUeQ==", "name": "Redline Flips", "createdAt": "2026-06-20T09:15:42Z", "updatedAt": "2026-06-20T09:15:42Z" } } }, "fetch_soft_deleted_workspace": { "summary": "Fetch a soft-deleted workspace within the retention window", "value": { "workspace": { "id": "my5NahyPR+OwpdnC5vEDhA==", "name": "Dragon Lore Holdings", "description": "Archived after the AWP Dragon Lore portfolio was liquidated.", "createdAt": "2025-11-03T18:40:00Z", "updatedAt": "2026-05-28T11:05:12Z", "deletedAt": "2026-05-28T11:05:12Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/GetWorkspaces": { "post": { "operationId": "accounts.v1.Accounts.GetWorkspaces", "summary": "Fetch multiple workspaces by ID", "description": "Returns the workspaces for a list of IDs in a single call, confined to the caller's currently active workspace. A requested ID for any other workspace is reported separately, exactly like an ID that does not match a workspace at all.", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetWorkspacesRequest" }, "examples": { "get_workspaces": { "summary": "Fetch multiple workspaces by ID", "value": { "workspaceIds": [ "AAECAwQFBgcICQoLDA0ODw==", "9HrBC1jMQ3KlZw4CssPUeQ==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.GetWorkspacesResponse" }, "examples": { "get_workspaces": { "summary": "Fetch multiple workspaces by ID", "value": { "workspaces": [ { "id": "AAECAwQFBgcICQoLDA0ODw==", "name": "Acme Trading", "description": "Primary trading workspace.", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-03-02T14:22:30Z" } ], "notFoundIds": [ "9HrBC1jMQ3KlZw4CssPUeQ==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/LinkDiscord": { "post": { "operationId": "accounts.v1.Accounts.LinkDiscord", "summary": "Begin linking a Discord account", "description": "Starts the flow to link a Discord identity to the signed-in user and returns an authorization URL the caller opens to grant access.", "tags": [ "Account Linking" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.LinkDiscordRequest" }, "examples": { "link_discord": { "summary": "Begin linking a Discord account", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.LinkDiscordResponse" }, "examples": { "link_discord": { "summary": "Begin linking a Discord account", "value": { "authorizeUrl": "https://discord.com/oauth2/authorize?client_id=123456789\u0026response_type=code\u0026scope=identify+email\u0026state=abc123" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ListAPIKeys": { "post": { "operationId": "accounts.v1.Accounts.ListAPIKeys", "summary": "List workspace API keys", "description": "Returns the API keys for a workspace. The secret key value is never returned; only its prefix and metadata are shown.", "tags": [ "API Keys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListAPIKeysRequest" }, "examples": { "list_a_p_i_keys": { "summary": "List workspace API keys", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListAPIKeysResponse" }, "examples": { "list_a_p_i_keys": { "summary": "List workspace API keys", "value": { "apiKeys": [ { "id": "CgsMDQ4PEBESExQVFhcYGQ==", "name": "CI deploy key", "keyPrefix": "gm_live_8f3a", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "lastUsedAt": "2026-06-28T22:14:00Z", "expiresAt": "2027-06-29T00:00:00Z", "createdAt": "2026-06-29T12:00:00Z", "policies": [ "trading", "analytics" ] } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ListAuthenticationIdentities": { "post": { "operationId": "accounts.v1.Accounts.ListAuthenticationIdentities", "summary": "List a user's linked sign-in identities", "description": "Returns the external sign-in identities, such as Discord, linked to the given user account.", "tags": [ "Account Linking" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListAuthenticationIdentitiesRequest" }, "examples": { "list_authentication_identities": { "summary": "List a user's linked sign-in identities", "value": { "userId": "EjRWeBI0VniQEjRWeBI0Vg==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListAuthenticationIdentitiesResponse" }, "examples": { "list_authentication_identities": { "summary": "List a user's linked sign-in identities", "value": { "authenticationIdentities": [ { "id": "GhscHR4fICEiIyQlJicoKQ==", "userId": "EjRWeBI0VniQEjRWeBI0Vg==", "provider": "AUTHENTICATION_PROVIDER_DISCORD", "providerId": "080808080808080808", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-01-15T10:00:00Z" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ListMemberships": { "post": { "operationId": "accounts.v1.Accounts.ListMemberships", "summary": "List memberships", "description": "Lists memberships, optionally filtered to a single workspace or user. Results are paginated; pass the returned cursor to fetch the next page.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListMembershipsRequest" }, "examples": { "list_memberships": { "summary": "List memberships", "value": { "limit": 50, "workspaceId": "AAECAwQFBgcICQoLDA0ODw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListMembershipsResponse" }, "examples": { "list_memberships": { "summary": "List memberships", "value": { "membershipIds": [ "VniQq83vEjRWeBI0VniQqw==", "ICEiIyQlJicoKSorLC0uLw==" ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ListPasskeys": { "post": { "operationId": "accounts.v1.Accounts.ListPasskeys", "summary": "List enrolled passkeys", "description": "Returns the passkeys enrolled on the signed-in user's account.", "tags": [ "Passkeys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListPasskeysRequest" }, "examples": { "list_passkeys": { "summary": "List enrolled passkeys", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListPasskeysResponse" }, "examples": { "list_passkeys": { "summary": "List enrolled passkeys", "value": { "passkeys": [ { "id": "GhscHR4fICEiIyQlJicoKQ==", "name": "MacBook Touch ID", "lastUsedAt": "2026-06-20T08:30:00Z", "createdAt": "2026-03-01T09:00:00Z" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ListPolicies": { "post": { "operationId": "accounts.v1.Accounts.ListPolicies", "summary": "List assignable policies", "description": "Returns the named policies that can be granted to memberships and API keys, each with the permissions it includes.", "tags": [ "Permissions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListPoliciesRequest" }, "examples": { "list_policies": { "summary": "List assignable policies", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListPoliciesResponse" }, "examples": { "list_policies": { "summary": "List assignable policies", "value": { "policies": [ { "name": "trading", "permissions": [ "PERMISSION_VIEW_CONTRACTS", "PERMISSION_MANAGE_CONTRACTS", "PERMISSION_VIEW_PURCHASES", "PERMISSION_MANAGE_PURCHASES" ] }, { "name": "analytics", "permissions": [ "PERMISSION_VIEW_ANALYTICS" ] } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ListSessions": { "post": { "operationId": "accounts.v1.Accounts.ListSessions", "summary": "List active sessions", "description": "Returns the caller's active sign-in sessions, including device, IP address, and last activity, so they can review and revoke them.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListSessionsRequest" }, "examples": { "list_sessions": { "summary": "List active sessions", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListSessionsResponse" }, "examples": { "list_sessions": { "summary": "List active sessions", "value": { "sessions": [ { "id": "GhscHR4fICEiIyQlJicoKQ==", "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36", "ipAddress": "203.0.113.42", "createdAt": "2026-06-28T20:00:00Z", "lastActiveAt": "2026-06-29T11:45:00Z", "isCurrent": true } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/ListWorkspaces": { "post": { "operationId": "accounts.v1.Accounts.ListWorkspaces", "summary": "List the caller's workspaces", "description": "Returns every workspace the caller holds an accepted membership in, regardless of which workspace is currently active. There is no workspace_id or user_id request field; the result always means the caller's own workspaces.", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListWorkspacesRequest" }, "examples": { "list_workspaces": { "summary": "List every workspace the caller belongs to", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.ListWorkspacesResponse" }, "examples": { "list_workspaces": { "summary": "List every workspace the caller belongs to", "value": { "workspaces": [ { "id": "AAECAwQFBgcICQoLDA0ODw==", "name": "Acme Trading", "description": "Primary trading workspace.", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-03-02T14:22:30Z" }, { "id": "9HrBC1jMQ3KlZw4CssPUeQ==", "name": "Redline Flips", "createdAt": "2026-06-29T12:00:00Z", "updatedAt": "2026-06-29T12:00:00Z" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/RegenerateBackupCodes": { "post": { "operationId": "accounts.v1.Accounts.RegenerateBackupCodes", "summary": "Regenerate two-factor backup codes", "description": "Issues a fresh set of one-time backup codes and invalidates the previous set. The caller must supply their password and a current authenticator code to confirm.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.RegenerateBackupCodesRequest" }, "examples": { "regenerate_backup_codes": { "summary": "Regenerate two-factor backup codes", "value": { "password": "correct-horse-battery-staple", "totpCode": "123456" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.RegenerateBackupCodesResponse" }, "examples": { "regenerate_backup_codes": { "summary": "Regenerate two-factor backup codes", "value": { "backupCodes": [ "a1b2-c3d4", "e5f6-g7h8", "i9j0-k1l2", "m3n4-o5p6" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/RotateWorkspaceKey": { "post": { "operationId": "accounts.v1.Accounts.RotateWorkspaceKey", "summary": "Rotate a workspace encryption key", "description": "Generates a fresh encryption key for the workspace so new sensitive data is protected under the latest key. Returns the previous and new key versions.", "tags": [ "Workspace Keys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.RotateWorkspaceKeyRequest" }, "examples": { "rotate_workspace_key": { "summary": "Rotate a workspace encryption key", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.RotateWorkspaceKeyResponse" }, "examples": { "rotate_workspace_key": { "summary": "Rotate a workspace encryption key", "value": { "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "fromVersion": 1, "toVersion": 2 } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/SetMembershipPolicies": { "post": { "operationId": "accounts.v1.Accounts.SetMembershipPolicies", "summary": "Set a member's operational policies", "description": "Replaces the operational policies granted to a member, controlling which capabilities such as trading, Steam, proxies, and analytics they may use. Owners hold all access by role and cannot be assigned policies.", "tags": [ "Memberships" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.SetMembershipPoliciesRequest" }, "examples": { "set_membership_policies": { "summary": "Set a member's operational policies", "value": { "membershipId": "ICEiIyQlJicoKSorLC0uLw==", "policies": [ "trading", "steam", "proxies" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.SetMembershipPoliciesResponse" }, "examples": { "set_membership_policies": { "summary": "Set a member's operational policies", "value": { "membership": { "id": "ICEiIyQlJicoKSorLC0uLw==", "userId": "q83vq83vEjRWeBI0VniQqg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "role": "MEMBERSHIP_ROLE_MEMBER", "status": "MEMBERSHIP_STATUS_ACCEPTED", "createdAt": "2026-06-29T12:00:00Z", "updatedAt": "2026-06-29T12:15:00Z", "policies": [ "trading", "steam", "proxies" ] } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/SetTwoFactorMethod": { "post": { "operationId": "accounts.v1.Accounts.SetTwoFactorMethod", "summary": "Set the active two-factor method", "description": "Chooses which enrolled method, authenticator app or email, is used as the primary two-factor challenge at sign-in. A passkey can never be set here, since a passkey login is itself a complete sign-in rather than a second factor.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.SetTwoFactorMethodRequest" }, "examples": { "set_two_factor_method": { "summary": "Set the active two-factor method", "value": { "method": "TWO_FACTOR_METHOD_TOTP" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.SetTwoFactorMethodResponse" }, "examples": { "set_two_factor_method": { "summary": "Set the active two-factor method", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/SetupTOTP": { "post": { "operationId": "accounts.v1.Accounts.SetupTOTP", "summary": "Begin authenticator app setup", "description": "Starts enrolling an authenticator app for two-factor sign-in. Returns the shared secret, a QR code to scan, and one-time backup codes. The setup must be confirmed with a generated code before it takes effect.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.SetupTOTPRequest" }, "examples": { "setup_t_o_t_p": { "summary": "Begin authenticator app setup", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.SetupTOTPResponse" }, "examples": { "setup_t_o_t_p": { "summary": "Begin authenticator app setup", "value": { "qrCodeBase64": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+M8AAAMBAQDJ/pLvAAAAAElFTkSuQmCC", "secret": "JBSWY3DPEHPK3PXP", "issuer": "Goldmine", "accountName": "jordan@acme.example", "backupCodes": [ "a1b2-c3d4", "e5f6-g7h8", "i9j0-k1l2" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/UpdateUser": { "post": { "operationId": "accounts.v1.Accounts.UpdateUser", "summary": "Update a user", "description": "Updates a user's display name or email address. Only the fields you supply are changed.", "tags": [ "Users" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.UpdateUserRequest" }, "examples": { "update_user": { "summary": "Update a user", "value": { "userId": "EjRWeBI0VniQEjRWeBI0Vg==", "name": "Jordan A. Hale" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.UpdateUserResponse" }, "examples": { "update_user": { "summary": "Update a user", "value": { "user": { "id": "EjRWeBI0VniQEjRWeBI0Vg==", "name": "Jordan A. Hale", "email": "jordan@acme.example", "status": "active", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-06-29T12:05:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/UpdateWorkspace": { "post": { "operationId": "accounts.v1.Accounts.UpdateWorkspace", "summary": "Update a workspace", "description": "Updates the caller's active workspace's name or description. The target is always the workspace resolved from the caller's session or API key, never a request field, so a caller can never name a different workspace to update. Only the fields you supply are changed.", "tags": [ "Workspaces" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.UpdateWorkspaceRequest" }, "examples": { "update_workspace": { "summary": "Update a workspace", "value": { "description": "Primary trading and inventory workspace." } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.UpdateWorkspaceResponse" }, "examples": { "update_workspace": { "summary": "Update a workspace", "value": { "workspace": { "id": "AAECAwQFBgcICQoLDA0ODw==", "name": "Acme Trading", "description": "Primary trading and inventory workspace.", "createdAt": "2026-01-15T10:00:00Z", "updatedAt": "2026-06-29T12:05:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/VerifyStepUp": { "post": { "operationId": "accounts.v1.Accounts.VerifyStepUp", "summary": "Complete a step-up re-verification", "description": "Completes a step-up challenge by supplying one verification code. On success the caller is briefly marked as freshly re-verified so they can perform a sensitive action.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.VerifyStepUpRequest" }, "examples": { "verify_step_up": { "summary": "Complete a step-up re-verification", "value": { "challengeId": "chl_8f3a2b1c9d4e", "totpCode": "123456" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.VerifyStepUpResponse" }, "examples": { "verify_step_up": { "summary": "Complete a step-up re-verification", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/accounts.v1.Accounts/VerifyTOTPSetup": { "post": { "operationId": "accounts.v1.Accounts.VerifyTOTPSetup", "summary": "Confirm authenticator app setup", "description": "Confirms authenticator app enrollment by verifying a code generated by the app. Once confirmed, the authenticator becomes an available two-factor method.", "tags": [ "Two-Factor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.VerifyTOTPSetupRequest" }, "examples": { "verify_t_o_t_p_setup": { "summary": "Confirm authenticator app setup", "value": { "code": "123456" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accounts.v1.VerifyTOTPSetupResponse" }, "examples": { "verify_t_o_t_p_setup": { "summary": "Confirm authenticator app setup", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/analytics.v1.Analytics/EvaluateContract": { "post": { "operationId": "analytics.v1.Analytics.EvaluateContract", "summary": "Evaluate a contract against current market data", "description": "Runs a contract's predicate and valuation against the latest market data and returns the matching items together with the maximum price to pay for each. Results are paginated through a cursor. Use this to preview what a contract would buy before activating it.", "tags": [ "Contract Evaluation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.EvaluateContractRequest" }, "examples": { "evaluate_contract": { "summary": "Evaluate a contract against current market data", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_RARITY", "operator": "PREDICATE_OPERATOR_IN", "value": { "stringListValue": { "values": [ "Covert", "Classified" ] } } } }, { "rule": { "marketData": { "source": "market-csgo", "metric": "volume" }, "operator": "PREDICATE_OPERATOR_GTE", "value": { "numberValue": 5 } } }, { "rule": { "valueField": "PREDICATE_VALUE_FIELD_COMPUTED_PRICE", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 150000 } } } ] } }, "valuation": { "references": [ { "source": "market-csgo", "metric": "listing-price", "adjustment": -0.05 } ], "strategy": "VALUATION_STRATEGY_MIN" }, "limit": 100 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.EvaluateContractResponse" }, "examples": { "evaluate_contract": { "summary": "Evaluate a contract against current market data", "value": { "intents": [ { "marketHashName": "AK-47 | Redline (Field-Tested)", "maxBuyPriceCents": "142500", "referencePrices": [ { "referenceIndex": 0, "source": "market-csgo", "metric": "listing-price", "valueCents": "150000", "priceCents": "142500" } ], "minFloat": 0.15, "maxFloat": 0.38 } ], "nextCursor": "eyJtIjoiQUstNDcgfCBSZWRsaW5lIChGaWVsZC1UZXN0ZWQpIn0=" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/analytics.v1.Analytics/GetAvailableMetrics": { "post": { "operationId": "analytics.v1.Analytics.GetAvailableMetrics", "summary": "List the market metrics available for an item", "description": "Returns the set of source and metric combinations that currently have data for a given item, so a caller knows which series it can chart or filter on. An item with no recorded data returns an empty list.", "tags": [ "Market Observations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetAvailableMetricsRequest" }, "examples": { "get_available_metrics": { "summary": "List the market metrics available for an item", "value": { "marketHashName": "AK-47 | Redline (Field-Tested)" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetAvailableMetricsResponse" }, "examples": { "get_available_metrics": { "summary": "List the market metrics available for an item", "value": { "sourceMetrics": [ { "source": "market-csgo", "metric": "listing-price" }, { "source": "market-csgo", "metric": "volume" }, { "source": "buff163", "metric": "listing-price" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/analytics.v1.Analytics/GetContractCoverage": { "post": { "operationId": "analytics.v1.Analytics.GetContractCoverage", "summary": "Report how much of a predicate's matched catalog the valuation can price", "description": "Runs a contract's predicate against the catalog exactly as EvaluateContract does, but reports every matched item instead of only the ones the valuation could price. Returns the count of matched items, how many of those the valuation prices, how many it does not, and a capped sample of the unpriced item names. Use this to show a member which of their predicate's matches have no usable market price before they activate the contract.", "tags": [ "Contract Evaluation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetContractCoverageRequest" }, "examples": { "get_contract_coverage": { "summary": "Report how much of a predicate's matched catalog the valuation can price", "value": { "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_RARITY", "operator": "PREDICATE_OPERATOR_IN", "value": { "stringListValue": { "values": [ "Covert", "Classified" ] } } } } ] } }, "valuation": { "references": [ { "source": "market-csgo", "metric": "listing-price", "adjustment": -0.05 } ], "strategy": "VALUATION_STRATEGY_MIN" }, "sampleLimit": 100 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetContractCoverageResponse" }, "examples": { "get_contract_coverage": { "summary": "Report how much of a predicate's matched catalog the valuation can price", "value": { "matchedCount": 200, "pricedCount": 160, "unpricedCount": 40, "unpricedMarketHashNames": [ "AK-47 | Bloodsport (Battle-Scarred)", "AK-47 | Vulcan (Battle-Scarred)" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/analytics.v1.Analytics/GetMarketObservationTimeSeries": { "post": { "operationId": "analytics.v1.Analytics.GetMarketObservationTimeSeries", "summary": "Get historical market metric time series for an item", "description": "Returns historical data points for the requested source and metric combinations of an item over a time range. Each series is a list of timestamped values suitable for plotting price and volume history.", "tags": [ "Market Observations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetMarketObservationTimeSeriesRequest" }, "examples": { "get_market_observation_time_series": { "summary": "Get historical market metric time series for an item", "value": { "marketHashName": "AK-47 | Redline (Field-Tested)", "sourceMetrics": [ { "source": "market-csgo", "metric": "listing-price" } ], "startTime": "2026-06-22T00:00:00Z", "endTime": "2026-06-29T00:00:00Z" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetMarketObservationTimeSeriesResponse" }, "examples": { "get_market_observation_time_series": { "summary": "Get historical market metric time series for an item", "value": { "series": [ { "source": "market-csgo", "metric": "listing-price", "points": [ { "timestamp": "2026-06-22T00:00:00Z", "value": 151200 }, { "timestamp": "2026-06-23T00:00:00Z", "value": 150400 } ] } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/analytics.v1.Analytics/GetPricing": { "post": { "operationId": "analytics.v1.Analytics.GetPricing", "summary": "Get the latest pricing for items across sources", "description": "Returns the most recent price, bid, listing count, volume, and liquidity figures for one or more items, optionally narrowed to specific market sources. Every monetary value is reported in US cents.", "tags": [ "Pricing" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetPricingRequest" }, "examples": { "get_pricing": { "summary": "Get the latest pricing for items across sources", "value": { "marketHashNames": [ "AK-47 | Redline (Field-Tested)", "AWP | Asiimov (Field-Tested)" ], "sources": [ "market-csgo", "buff163" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.GetPricingResponse" }, "examples": { "get_pricing": { "summary": "Get the latest pricing for items across sources", "value": { "entries": [ { "marketHashName": "AK-47 | Redline (Field-Tested)", "source": "market-csgo", "priceCents": "150000", "bidCents": "148000", "listingsCount": 342, "volume": 128, "avg7dCents": "151200", "avg30dCents": "149800", "liquidity": 0.82, "observedAt": "2026-06-29T11:30:00Z", "supply": 342 } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/analytics.v1.Analytics/ListInventoryItemChanges": { "post": { "operationId": "analytics.v1.Analytics.ListInventoryItemChanges", "summary": "List recorded inventory changes for a Steam account", "description": "Returns the change log of inventory items added, updated, or removed for a Steam account in a workspace, newest first. Results are paginated through a cursor, and an account with no recorded changes returns an empty list.", "tags": [ "Inventory Changes" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.ListInventoryItemChangesRequest" }, "examples": { "list_inventory_item_changes": { "summary": "List recorded inventory changes for a Steam account", "value": { "accountName": "trade_bot_01", "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/analytics.v1.ListInventoryItemChangesResponse" }, "examples": { "list_inventory_item_changes": { "summary": "List recorded inventory changes for a Steam account", "value": { "changes": [ { "assetId": "38502819374", "observedAt": "2026-06-29T11:42:13Z", "action": "created", "classId": "5564148233", "instanceId": "188530139", "marketHashName": "AK-47 | Redline (Field-Tested)", "appId": 730, "contextId": "2", "amount": "1" } ], "nextCursor": "eyJvIjoiMjAyNi0wNi0yOVQxMTo0MjoxM1oiLCJhIjoiMzg1MDI4MTkzNzQifQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CountAccountGroups": { "post": { "operationId": "contracts.v1.Contracts.CountAccountGroups", "summary": "Count account groups in a workspace", "description": "Returns the number of account groups in the workspace, so a list page can render a count without loading and counting every row.", "tags": [ "Account Groups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountAccountGroupsRequest" }, "examples": { "count_account_groups": { "summary": "Count account groups in the workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountAccountGroupsResponse" }, "examples": { "count_account_groups": { "summary": "Count account groups in the workspace", "value": { "count": 3 } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CountContracts": { "post": { "operationId": "contracts.v1.Contracts.CountContracts", "summary": "Count contracts per status in a workspace", "description": "Returns the number of contracts in each status for the workspace, optionally filtered by type. Drives the list page status-tab counts (All, Active, Draft) without loading every contract.", "tags": [ "Contracts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountContractsRequest" }, "examples": { "count_buying_empty_workspace": { "summary": "Count buying contracts in a workspace with none", "value": { "type": "CONTRACT_TYPE_BUYING" } }, "count_by_status": { "summary": "Count every contract in the workspace by status", "value": {} }, "count_selling_by_status": { "summary": "Count only selling contracts by status", "value": { "type": "CONTRACT_TYPE_SELLING" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountContractsResponse" }, "examples": { "count_buying_empty_workspace": { "summary": "Count buying contracts in a workspace with none", "value": {} }, "count_by_status": { "summary": "Count every contract in the workspace by status", "value": { "counts": [ { "status": "CONTRACT_STATUS_ACTIVE", "count": 12 }, { "status": "CONTRACT_STATUS_DRAFT", "count": 3 } ] } }, "count_selling_by_status": { "summary": "Count only selling contracts by status", "value": { "counts": [ { "status": "CONTRACT_STATUS_ACTIVE", "count": 7 }, { "status": "CONTRACT_STATUS_BUILDING", "count": 1 }, { "status": "CONTRACT_STATUS_DRAFT", "count": 4 } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CountFilterSets": { "post": { "operationId": "contracts.v1.Contracts.CountFilterSets", "summary": "Count filter sets in a workspace", "description": "Returns the number of filter sets in the workspace, so a list page can render a count without loading and counting every row.", "tags": [ "Filter Sets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountFilterSetsRequest" }, "examples": { "count_filter_sets": { "summary": "Count filter sets in the workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountFilterSetsResponse" }, "examples": { "count_filter_sets": { "summary": "Count filter sets in the workspace", "value": { "count": 3 } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CountInventoryItems": { "post": { "operationId": "contracts.v1.Contracts.CountInventoryItems", "summary": "Count inventory items per status in a workspace", "description": "Returns the number of inventory items in each status for the workspace, optionally filtered by contract_id. Drives the inventory list page status-tab counts without loading every item.", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountInventoryItemsRequest" }, "examples": { "count_by_status": { "summary": "Count every inventory item in the workspace by status", "value": {} }, "count_empty_workspace": { "summary": "Count inventory items in a workspace with none", "value": {} }, "count_for_contract": { "summary": "Count only inventory items attributed to a specific contract", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountInventoryItemsResponse" }, "examples": { "count_by_status": { "summary": "Count every inventory item in the workspace by status", "value": { "counts": [ { "status": "INVENTORY_ITEM_STATUS_IN_INVENTORY", "count": 12 }, { "status": "INVENTORY_ITEM_STATUS_LISTED", "count": 3 } ] } }, "count_empty_workspace": { "summary": "Count inventory items in a workspace with none", "value": {} }, "count_for_contract": { "summary": "Count only inventory items attributed to a specific contract", "value": { "counts": [ { "status": "INVENTORY_ITEM_STATUS_SOLD", "count": 5 } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CountPurchases": { "post": { "operationId": "contracts.v1.Contracts.CountPurchases", "summary": "Count purchases per status in a workspace", "description": "Returns the number of purchases in each status for the workspace, optionally filtered by contract_id. Drives the purchases list page status-tab counts without loading every purchase.", "tags": [ "Purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountPurchasesRequest" }, "examples": { "count_by_status": { "summary": "Count every purchase in the workspace by status", "value": {} }, "count_empty_workspace": { "summary": "Count purchases in a workspace with none", "value": {} }, "count_for_contract": { "summary": "Count only purchases attributed to a specific contract", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountPurchasesResponse" }, "examples": { "count_by_status": { "summary": "Count every purchase in the workspace by status", "value": { "counts": [ { "status": "PURCHASE_STATUS_TRADED", "count": 12 }, { "status": "PURCHASE_STATUS_PENDING", "count": 3 } ] } }, "count_empty_workspace": { "summary": "Count purchases in a workspace with none", "value": {} }, "count_for_contract": { "summary": "Count only purchases attributed to a specific contract", "value": { "counts": [ { "status": "PURCHASE_STATUS_TRADED", "count": 7 }, { "status": "PURCHASE_STATUS_TRADES_PENDING", "count": 1 } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CountSnapshots": { "post": { "operationId": "contracts.v1.Contracts.CountSnapshots", "summary": "Count snapshots for a contract", "description": "Returns the total number of evaluation snapshots for a contract, so the contract detail page can render the true total without loading and counting every page.", "tags": [ "Snapshots" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountSnapshotsRequest" }, "examples": { "count_snapshots": { "summary": "Count snapshots for a contract", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CountSnapshotsResponse" }, "examples": { "count_snapshots": { "summary": "Count snapshots for a contract", "value": { "count": 118 } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CreateAccountGroup": { "post": { "operationId": "contracts.v1.Contracts.CreateAccountGroup", "summary": "Create an account group", "description": "Creates a named, reusable set of Steam account names that contracts can reference and execute against.", "tags": [ "Account Groups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CreateAccountGroupRequest" }, "examples": { "create_account_group": { "summary": "Create an account group", "value": { "name": "AK-47 Redline buyers", "members": [ "redline_trader_eu", "redline_trader_us", "float_hunter_01" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CreateAccountGroupResponse" }, "examples": { "create_account_group": { "summary": "Create an account group", "value": { "accountGroup": { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 Redline buyers", "members": [ "redline_trader_eu", "redline_trader_us", "float_hunter_01" ], "createdAt": "2026-06-29T10:00:00Z", "updatedAt": "2026-06-29T10:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CreateContract": { "post": { "operationId": "contracts.v1.Contracts.CreateContract", "summary": "Create a contract", "description": "Creates a new buying or selling contract in the workspace. A new contract starts as a draft and is activated separately once it has a valuation.", "tags": [ "Contracts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CreateContractRequest" }, "examples": { "create_contract": { "summary": "Create a contract", "value": { "name": "AK-47 Redline under $50", "description": "Buy AK-47 Redline in Field-Tested or better below $50 on CSFloat.", "type": "CONTRACT_TYPE_BUYING", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.38 } } }, { "rule": { "valueField": "PREDICATE_VALUE_FIELD_COMPUTED_PRICE", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 5000 } } } ] } }, "valuation": { "references": [ { "source": "buff163", "metric": "sell_min" } ], "strategy": "VALUATION_STRATEGY_MIN" }, "strategies": [ { "csfloatBuyOrder": { "maxOrders": 3, "maxPriceCents": 5000 } } ], "accountGroupId": "oKCgoAQFBgcICQoLDA0ODw==", "limits": { "maxOwnedPerItem": 2, "purchaseWindow": { "count": 10, "days": 7 }, "spendWindow": { "amountCents": "50000", "days": 7 } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CreateContractResponse" }, "examples": { "create_contract": { "summary": "Create a contract", "value": { "contract": { "id": "MDEyMzQ1Njc4OTo7PD0+Pw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 Redline under $50", "description": "Buy AK-47 Redline in Field-Tested or better below $50 on CSFloat.", "status": "CONTRACT_STATUS_DRAFT", "type": "CONTRACT_TYPE_BUYING", "createdAt": "2026-06-29T10:00:00Z", "updatedAt": "2026-06-29T10:00:00Z", "version": "1", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.38 } } }, { "rule": { "valueField": "PREDICATE_VALUE_FIELD_COMPUTED_PRICE", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 5000 } } } ] } }, "valuation": { "references": [ { "source": "buff163", "metric": "sell_min" } ], "strategy": "VALUATION_STRATEGY_MIN" }, "strategies": [ { "csfloatBuyOrder": { "maxOrders": 3, "maxPriceCents": 5000 } } ], "accountGroupId": "oKCgoAQFBgcICQoLDA0ODw==", "limits": { "maxOwnedPerItem": 2, "purchaseWindow": { "count": 10, "days": 7 }, "spendWindow": { "amountCents": "50000", "days": 7 } } } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/CreateFilterSet": { "post": { "operationId": "contracts.v1.Contracts.CreateFilterSet", "summary": "Create a filter set", "description": "Creates a named, reusable predicate fragment in the workspace that contracts can reference by ID.", "tags": [ "Filter Sets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CreateFilterSetRequest" }, "examples": { "create_filter_set": { "summary": "Create a filter set", "value": { "name": "Asiimov watchlist", "description": "Curated list of Asiimov market hash names tracked across selling contracts.", "predicate": { "rule": { "field": "PREDICATE_FIELD_MARKET_HASH_NAME", "operator": "PREDICATE_OPERATOR_IN", "value": { "stringListValue": { "values": [ "AWP | Asiimov (Field-Tested)", "AWP | Asiimov (Well-Worn)", "M4A4 | Asiimov (Field-Tested)" ] } } } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.CreateFilterSetResponse" }, "examples": { "create_filter_set": { "summary": "Create a filter set", "value": { "filterSet": { "id": "ICEiIyQlJicoKSorLC0uLw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "Asiimov watchlist", "description": "Curated list of Asiimov market hash names tracked across selling contracts.", "predicate": { "rule": { "field": "PREDICATE_FIELD_MARKET_HASH_NAME", "operator": "PREDICATE_OPERATOR_IN", "value": { "stringListValue": { "values": [ "AWP | Asiimov (Field-Tested)", "AWP | Asiimov (Well-Worn)", "M4A4 | Asiimov (Field-Tested)" ] } } } }, "version": "1", "createdAt": "2026-06-29T10:00:00Z", "updatedAt": "2026-06-29T10:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/DeleteAccountGroup": { "post": { "operationId": "contracts.v1.Contracts.DeleteAccountGroup", "summary": "Delete an account group", "description": "Soft-deletes the account group identified by the given ID so it can no longer be referenced by new contracts.", "tags": [ "Account Groups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.DeleteAccountGroupRequest" }, "examples": { "delete_account_group": { "summary": "Delete an account group", "value": { "accountGroupId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.DeleteAccountGroupResponse" }, "examples": { "delete_account_group": { "summary": "Delete an account group", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/DeleteContract": { "post": { "operationId": "contracts.v1.Contracts.DeleteContract", "summary": "Delete a contract", "description": "Soft-deletes the contract identified by the given ID. The contract stops evaluating and no longer appears in lists.", "tags": [ "Contracts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.DeleteContractRequest" }, "examples": { "delete_contract": { "summary": "Delete a contract", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.DeleteContractResponse" }, "examples": { "delete_contract": { "summary": "Delete a contract", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/DeleteFilterSet": { "post": { "operationId": "contracts.v1.Contracts.DeleteFilterSet", "summary": "Delete a filter set", "description": "Soft-deletes the filter set identified by the given ID so it can no longer be referenced by new contracts.", "tags": [ "Filter Sets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.DeleteFilterSetRequest" }, "examples": { "delete_filter_set": { "summary": "Delete a filter set", "value": { "filterSetId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.DeleteFilterSetResponse" }, "examples": { "delete_filter_set": { "summary": "Delete a filter set", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetAccountGroup": { "post": { "operationId": "contracts.v1.Contracts.GetAccountGroup", "summary": "Fetch a single account group by ID", "description": "Returns the account group identified by account_group_id. Soft-deleted account groups are not returned.", "tags": [ "Account Groups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetAccountGroupRequest" }, "examples": { "fetch_empty_membership_account_group": { "summary": "Fetch a newly created account group with no members yet", "value": { "accountGroupId": "ICEiIyQlJicoKSorLC0uLw==" } }, "fetch_populated_account_group": { "summary": "Fetch an account group with several Steam accounts", "value": { "accountGroupId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetAccountGroupResponse" }, "examples": { "fetch_empty_membership_account_group": { "summary": "Fetch a newly created account group with no members yet", "value": { "accountGroup": { "id": "ICEiIyQlJicoKSorLC0uLw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "Butterfly Knife Fade stock accounts", "createdAt": "2026-06-25T11:00:00Z", "updatedAt": "2026-06-25T11:00:00Z" } } }, "fetch_populated_account_group": { "summary": "Fetch an account group with several Steam accounts", "value": { "accountGroup": { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 Redline buyers", "members": [ "redline_trader_eu", "redline_trader_us", "float_hunter_01" ], "createdAt": "2026-03-12T08:30:00Z", "updatedAt": "2026-05-20T14:45:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetAccountGroups": { "post": { "operationId": "contracts.v1.Contracts.GetAccountGroups", "summary": "Fetch multiple account groups by ID", "description": "Returns the account groups matching the given IDs within a workspace, alongside the IDs that did not resolve. Soft-deleted account groups are treated as not found.", "tags": [ "Account Groups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetAccountGroupsRequest" }, "examples": { "get_account_groups": { "summary": "Fetch multiple account groups by ID", "value": { "accountGroupIds": [ "EBESExQVFhcYGRobHB0eHw==", "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetAccountGroupsResponse" }, "examples": { "get_account_groups": { "summary": "Fetch multiple account groups by ID", "value": { "accountGroups": [ { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 Redline buyers", "members": [ "redline_trader_eu", "redline_trader_us", "float_hunter_01" ], "createdAt": "2026-03-12T08:30:00Z", "updatedAt": "2026-05-20T14:45:00Z" } ], "notFoundIds": [ "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetContract": { "post": { "operationId": "contracts.v1.Contracts.GetContract", "summary": "Fetch a single contract by ID", "description": "Returns the contract identified by contract_id within the caller's active workspace. Soft-deleted contracts are not returned.", "tags": [ "Contracts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetContractRequest" }, "examples": { "fetch_active_buying_contract": { "summary": "Fetch an active buying contract", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==" } }, "fetch_building_stattrak_buying_contract": { "summary": "Fetch a building StatTrak buying contract", "value": { "contractId": "MDEyMzQ1Njc4OTo7PD0+Pw==" } }, "fetch_draft_selling_contract": { "summary": "Fetch a draft selling contract", "value": { "contractId": "ICEiIyQlJicoKSorLC0uLw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetContractResponse" }, "examples": { "fetch_active_buying_contract": { "summary": "Fetch an active buying contract", "value": { "contract": { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 under $50", "description": "Buy any AK-47 skin priced below $50 on CSFloat.", "status": "CONTRACT_STATUS_ACTIVE", "type": "CONTRACT_TYPE_BUYING", "createdAt": "2026-02-10T09:00:00Z", "updatedAt": "2026-04-01T12:15:00Z", "version": "3", "snapshot": "7" } } }, "fetch_building_stattrak_buying_contract": { "summary": "Fetch a building StatTrak buying contract", "value": { "contract": { "id": "MDEyMzQ1Njc4OTo7PD0+Pw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "StatTrak AK-47 Redline sniper", "description": "Buy StatTrak AK-47 Redline in Field-Tested under 75 dollars.", "status": "CONTRACT_STATUS_BUILDING", "type": "CONTRACT_TYPE_BUYING", "createdAt": "2026-06-15T08:05:00Z", "updatedAt": "2026-06-29T10:42:00Z", "version": "5", "snapshot": "12", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_HAS_STAT_TRAK", "operator": "PREDICATE_OPERATOR_EQ", "value": { "boolValue": true } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.38 } } }, { "rule": { "marketData": { "source": "market-csgo", "metric": "volume" }, "operator": "PREDICATE_OPERATOR_GTE", "value": { "numberValue": 20 } } }, { "rule": { "marketData": { "source": "market-csgo", "metric": "volume" }, "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 5000 } } }, { "rule": { "valueField": "PREDICATE_VALUE_FIELD_COMPUTED_PRICE", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 7500 } } } ] } }, "valuation": { "references": [ { "source": "market-csgo", "metric": "price", "adjustment": -5 }, { "source": "buff163", "metric": "sell_min", "adjustment": -3 } ], "strategy": "VALUATION_STRATEGY_MIN" }, "strategies": [ { "csfloatBuyOrder": { "maxOrders": 3, "maxPriceCents": 7000 } }, { "csfloatScraping": { "scrapeIntervalMs": "30000", "maxConcurrent": 4 } } ], "accountGroupId": "oKCgoAQFBgcICQoLDA0ODw==", "limits": { "maxOwnedPerItem": 2, "purchaseWindow": { "count": 10, "days": 7 }, "spendWindow": { "amountCents": "50000", "days": 7 } } } } }, "fetch_draft_selling_contract": { "summary": "Fetch a draft selling contract", "value": { "contract": { "id": "ICEiIyQlJicoKSorLC0uLw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AWP Asiimov resale", "description": "List Field-Tested AWP Asiimov skins on CSFloat at a 5 percent undercut.", "status": "CONTRACT_STATUS_DRAFT", "type": "CONTRACT_TYPE_SELLING", "createdAt": "2026-05-20T14:30:00Z", "updatedAt": "2026-05-20T14:30:00Z", "version": "1", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AWP" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Asiimov" } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.38 } } }, { "rule": { "marketData": { "source": "buff163", "metric": "sell_num" }, "operator": "PREDICATE_OPERATOR_GTE", "value": { "numberValue": 50 } } }, { "rule": { "valueField": "PREDICATE_VALUE_FIELD_COMPUTED_PRICE", "operator": "PREDICATE_OPERATOR_GTE", "value": { "numberValue": 6500 } } } ] } }, "valuation": { "references": [ { "source": "buff163", "metric": "sell_min" } ], "strategy": "VALUATION_STRATEGY_AVG" }, "strategies": [ { "csfloatSell": { "undercutPct": 5, "priceSource": "buff163" } }, { "offerHandling": { "autoDecline": true, "minOfferAcceptPct": 92 } } ], "accountGroupId": "sLGys7S1tre4ubq7vL2+vw==" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetContracts": { "post": { "operationId": "contracts.v1.Contracts.GetContracts", "summary": "Fetch multiple contracts by ID", "description": "Returns the contracts matching the given IDs within a workspace, alongside the IDs that did not resolve. Soft-deleted contracts are treated as not found.", "tags": [ "Contracts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetContractsRequest" }, "examples": { "get_contracts": { "summary": "Fetch multiple contracts by ID", "value": { "contractIds": [ "EBESExQVFhcYGRobHB0eHw==", "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetContractsResponse" }, "examples": { "get_contracts": { "summary": "Fetch multiple contracts by ID", "value": { "contracts": [ { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 under $50", "description": "Buy any AK-47 skin priced below $50 on CSFloat.", "status": "CONTRACT_STATUS_ACTIVE", "type": "CONTRACT_TYPE_BUYING", "createdAt": "2026-02-10T09:00:00Z", "updatedAt": "2026-04-01T12:15:00Z", "version": "3", "snapshot": "7" } ], "notFoundIds": [ "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetFilterSet": { "post": { "operationId": "contracts.v1.Contracts.GetFilterSet", "summary": "Fetch a single filter set by ID", "description": "Returns the filter set identified by filter_set_id within the caller's active workspace. Soft-deleted filter sets are not returned.", "tags": [ "Filter Sets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetFilterSetRequest" }, "examples": { "fetch_asiimov_watchlist_filter": { "summary": "Fetch a multi-skin watchlist filter set", "value": { "filterSetId": "ICEiIyQlJicoKSorLC0uLw==" } }, "fetch_stattrak_ak_redline_filter": { "summary": "Fetch a StatTrak AK-47 Redline filter set", "value": { "filterSetId": "EBESExQVFhcYGRobHB0eHw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetFilterSetResponse" }, "examples": { "fetch_asiimov_watchlist_filter": { "summary": "Fetch a multi-skin watchlist filter set", "value": { "filterSet": { "id": "ICEiIyQlJicoKSorLC0uLw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "Asiimov watchlist", "description": "Curated list of Asiimov market hash names tracked across selling contracts.", "predicate": { "rule": { "field": "PREDICATE_FIELD_MARKET_HASH_NAME", "operator": "PREDICATE_OPERATOR_IN", "value": { "stringListValue": { "values": [ "AWP | Asiimov (Field-Tested)", "AWP | Asiimov (Well-Worn)", "M4A4 | Asiimov (Field-Tested)" ] } } } }, "version": "1", "createdAt": "2026-05-12T11:20:00Z", "updatedAt": "2026-05-12T11:20:00Z" } } }, "fetch_stattrak_ak_redline_filter": { "summary": "Fetch a StatTrak AK-47 Redline filter set", "value": { "filterSet": { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "StatTrak AK-47 Redline, Field-Tested or better", "description": "Reusable fragment matching StatTrak AK-47 Redline skins with a float of 0.27 or lower.", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_HAS_STAT_TRAK", "operator": "PREDICATE_OPERATOR_EQ", "value": { "boolValue": true } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.27 } } } ] } }, "version": "2", "createdAt": "2026-03-05T14:30:00Z", "updatedAt": "2026-04-18T08:45:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetFilterSets": { "post": { "operationId": "contracts.v1.Contracts.GetFilterSets", "summary": "Fetch multiple filter sets by ID", "description": "Returns the filter sets matching the given IDs within a workspace, alongside the IDs that did not resolve. Soft-deleted filter sets are treated as not found.", "tags": [ "Filter Sets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetFilterSetsRequest" }, "examples": { "get_filter_sets": { "summary": "Fetch multiple filter sets by ID", "value": { "filterSetIds": [ "EBESExQVFhcYGRobHB0eHw==", "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetFilterSetsResponse" }, "examples": { "get_filter_sets": { "summary": "Fetch multiple filter sets by ID", "value": { "filterSets": [ { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "StatTrak AK-47 Redline, Field-Tested or better", "description": "Reusable fragment matching StatTrak AK-47 Redline skins with a float of 0.27 or lower.", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_HAS_STAT_TRAK", "operator": "PREDICATE_OPERATOR_EQ", "value": { "boolValue": true } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.27 } } } ] } }, "version": "2", "createdAt": "2026-03-05T14:30:00Z", "updatedAt": "2026-04-18T08:45:00Z" } ], "notFoundIds": [ "ICEiIyQlJicoKSorLC0uLw==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetIntent": { "post": { "operationId": "contracts.v1.Contracts.GetIntent", "summary": "Fetch a single contract intent by ID", "description": "Returns one evaluated buying or selling intent within a contract snapshot. An intent records the item, the float window, and the price the contract will pay or list at, along with the source prices behind it.", "tags": [ "Intents" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetIntentRequest" }, "examples": { "get_intent": { "summary": "Fetch a single contract intent by ID", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotId": "7", "intentId": "aW50ZW50LWl0ZW0tMDAwMQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetIntentResponse" }, "examples": { "get_intent": { "summary": "Fetch a single contract intent by ID", "value": { "intent": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotId": "7", "id": "aW50ZW50LWl0ZW0tMDAwMQ==", "marketHashName": "AK-47 | Redline (Field-Tested)", "maxBuyPriceCents": "4800", "maxFloat": 0.38, "referencePrices": [ { "referenceIndex": 0, "source": "buff163", "metric": "sell_min", "valueCents": "5000", "priceCents": "4800" } ], "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetIntents": { "post": { "operationId": "contracts.v1.Contracts.GetIntents", "summary": "Fetch multiple contract intents by ID", "description": "Returns the intents matching the given IDs within a contract snapshot, alongside the IDs that did not resolve.", "tags": [ "Intents" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetIntentsRequest" }, "examples": { "get_intents": { "summary": "Fetch multiple contract intents by ID", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotId": "7", "intentIds": [ "aW50ZW50LWl0ZW0tMDAwMQ==", "aW50ZW50LWl0ZW0tMDAwMg==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetIntentsResponse" }, "examples": { "get_intents": { "summary": "Fetch multiple contract intents by ID", "value": { "intents": [ { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotId": "7", "id": "aW50ZW50LWl0ZW0tMDAwMQ==", "marketHashName": "AK-47 | Redline (Field-Tested)", "maxBuyPriceCents": "4800", "maxFloat": 0.38, "referencePrices": [ { "referenceIndex": 0, "source": "buff163", "metric": "sell_min", "valueCents": "5000", "priceCents": "4800" } ], "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } ], "notFoundIds": [ "aW50ZW50LWl0ZW0tMDAwMg==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetInventoryItem": { "post": { "operationId": "contracts.v1.Contracts.GetInventoryItem", "summary": "Fetch a single inventory item by ID", "description": "Returns the inventory item identified by inventory_item_id. Inventory items track an owned asset from receipt through listing and sale, including the current Steam asset_id.", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetInventoryItemRequest" }, "examples": { "fetch_inventory_item": { "summary": "Fetch an inventory item currently held in the Steam inventory", "value": { "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDAx" } }, "held_inventory_item_under_trade_hold": { "summary": "Fetch a received item still under a Steam trade hold", "value": { "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDA3" } }, "sold_inventory_item_with_pnl": { "summary": "Fetch a sold item showing buy and sell prices", "value": { "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDAy" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetInventoryItemResponse" }, "examples": { "fetch_inventory_item": { "summary": "Fetch an inventory item currently held in the Steam inventory", "value": { "inventoryItem": { "id": "aW52ZW50b3J5LWl0ZW0tMDAx", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "purchaseId": "MDEyMzQ1Njc4OWFiY2RlZg==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "INVENTORY_ITEM_STATUS_IN_INVENTORY", "version": "2", "currentAssetId": "29384710999", "buyPriceCents": "4200", "createdAt": "2026-04-10T09:12:00Z", "updatedAt": "2026-04-10T09:45:00Z" } } }, "held_inventory_item_under_trade_hold": { "summary": "Fetch a received item still under a Steam trade hold", "value": { "inventoryItem": { "id": "aW52ZW50b3J5LWl0ZW0tMDA3", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "purchaseId": "YWJjZGVmMDEyMzQ1Njc4OQ==", "contractId": "MDEyMzQ1Njc4OTo7PD0+Pw==", "marketHashName": "M4A4 | Howl (Minimal Wear)", "status": "INVENTORY_ITEM_STATUS_IN_INVENTORY", "version": "1", "currentAssetId": "33558120947", "buyPriceCents": "245000", "floatValue": 0.0921, "tradable": false, "tradableAfter": "2026-07-06T14:30:00Z", "createdAt": "2026-06-29T14:30:00Z", "updatedAt": "2026-06-29T14:30:00Z" } } }, "sold_inventory_item_with_pnl": { "summary": "Fetch a sold item showing buy and sell prices", "value": { "inventoryItem": { "id": "aW52ZW50b3J5LWl0ZW0tMDAy", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "purchaseId": "ZmVkY2JhOTg3NjU0MzIxMA==", "contractId": "ICEiIyQlJicoKSorLC0uLw==", "marketHashName": "AWP | Asiimov (Field-Tested)", "status": "INVENTORY_ITEM_STATUS_SOLD", "version": "5", "currentAssetId": "31002847551", "buyPriceCents": "7350", "sellPriceCents": "9100", "floatValue": 0.2487, "tradable": true, "createdAt": "2026-05-02T18:20:00Z", "updatedAt": "2026-05-19T11:05:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetInventoryItems": { "post": { "operationId": "contracts.v1.Contracts.GetInventoryItems", "summary": "Fetch multiple inventory items by ID", "description": "Returns the inventory items matching the given IDs within a workspace, alongside the IDs that did not resolve.", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetInventoryItemsRequest" }, "examples": { "get_inventory_items": { "summary": "Fetch multiple inventory items by ID", "value": { "inventoryItemIds": [ "aW52ZW50b3J5LWl0ZW0tMDAx", "aW52ZW50b3J5LWl0ZW0tMDAy" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetInventoryItemsResponse" }, "examples": { "get_inventory_items": { "summary": "Fetch multiple inventory items by ID", "value": { "inventoryItems": [ { "id": "aW52ZW50b3J5LWl0ZW0tMDAx", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "purchaseId": "MDEyMzQ1Njc4OWFiY2RlZg==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "INVENTORY_ITEM_STATUS_IN_INVENTORY", "version": "2", "currentAssetId": "29384710999", "buyPriceCents": "4200", "tradable": true, "createdAt": "2026-04-10T09:12:00Z", "updatedAt": "2026-04-10T09:45:00Z" } ], "notFoundIds": [ "aW52ZW50b3J5LWl0ZW0tMDAy" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetPnLBreakdown": { "post": { "operationId": "contracts.v1.Contracts.GetPnLBreakdown", "summary": "Get profit and loss broken down by market and contract", "description": "Returns a workspace's profit and loss split by selling marketplace and by contract. The market split is realized only; the contract split pairs each contract's realized profit with the buy cost of the items it still holds.", "tags": [ "Profit and Loss" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPnLBreakdownRequest" }, "examples": { "get_pn_l_breakdown": { "summary": "Get profit and loss broken down by market and contract", "value": { "startTime": "2026-01-01T00:00:00Z", "endTime": "2026-06-30T23:59:59Z" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPnLBreakdownResponse" }, "examples": { "get_pn_l_breakdown": { "summary": "Get profit and loss broken down by market and contract", "value": { "byMarket": [ { "marketplace": "csfloat", "sellRevenueCents": "1320000", "realizedPnlCents": "205000", "itemsSold": "198" }, { "marketplace": "unknown", "sellRevenueCents": "160000", "realizedPnlCents": "25000", "itemsSold": "19" } ], "byContract": [ { "contractId": "EBESExQVFhcYGRobHB0eHw==", "realizedPnlCents": "150000", "unrealizedCostCents": "220000", "itemsSold": "120", "itemsInInventory": "40" }, { "contractId": "ICEiIyQlJicoKSorLC0uLw==", "realizedPnlCents": "80000", "unrealizedCostCents": "200000", "itemsSold": "97", "itemsInInventory": "55" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetPnLPeriods": { "post": { "operationId": "contracts.v1.Contracts.GetPnLPeriods", "summary": "Get profit and loss over time periods", "description": "Returns a workspace's profit and loss bucketed into day, week, or month periods across a time range, for plotting trends. Optionally scoped to a single contract.", "tags": [ "Profit and Loss" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPnLPeriodsRequest" }, "examples": { "get_pn_l_periods": { "summary": "Get profit and loss over time periods", "value": { "startTime": "2026-04-01T00:00:00Z", "endTime": "2026-06-30T23:59:59Z", "granularity": "month" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPnLPeriodsResponse" }, "examples": { "get_pn_l_periods": { "summary": "Get profit and loss over time periods", "value": { "periods": [ { "periodStart": "2026-04-01T00:00:00Z", "periodEnd": "2026-04-30T23:59:59Z", "buyCostCents": "420000", "sellRevenueCents": "510000", "pnlCents": "90000", "purchaseCount": "104" }, { "periodStart": "2026-05-01T00:00:00Z", "periodEnd": "2026-05-31T23:59:59Z", "buyCostCents": "380000", "sellRevenueCents": "445000", "pnlCents": "65000", "purchaseCount": "96" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetPnLSummary": { "post": { "operationId": "contracts.v1.Contracts.GetPnLSummary", "summary": "Get aggregate profit and loss for a workspace", "description": "Returns the workspace's aggregate profit and loss, including total buy cost, sell revenue, realized and unrealized figures, and item counts. Optionally scoped to one contract and a time range.", "tags": [ "Profit and Loss" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPnLSummaryRequest" }, "examples": { "get_pn_l_summary": { "summary": "Get aggregate profit and loss for a workspace", "value": { "startTime": "2026-01-01T00:00:00Z", "endTime": "2026-06-30T23:59:59Z" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPnLSummaryResponse" }, "examples": { "get_pn_l_summary": { "summary": "Get aggregate profit and loss for a workspace", "value": { "summary": { "totalBuyCostCents": "1250000", "totalSellRevenueCents": "1480000", "realizedPnlCents": "230000", "unrealizedCostCents": "420000", "totalPurchases": "312", "itemsInInventory": "95", "itemsSold": "217" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetPurchase": { "post": { "operationId": "contracts.v1.Contracts.GetPurchase", "summary": "Fetch a single purchase by ID", "description": "Returns the purchase identified by purchase_id within the caller's active workspace. Purchases track an item acquisition from attribution through marketplace completion and Steam trade.", "tags": [ "Purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPurchaseRequest" }, "examples": { "fetch_completed_purchase": { "summary": "Fetch a completed purchase that has been received via Steam trade", "value": { "purchaseId": "MDEyMzQ1Njc4OWFiY2RlZg==" } }, "fetch_flagged_trades_pending_purchase": { "summary": "Fetch a trade awaiting Steam delivery that reconciliation flagged for review", "value": { "purchaseId": "X049LBsKmYh3ZlVEMyIRAA==" } }, "fetch_pending_buy_order_purchase": { "summary": "Fetch a pending purchase filled from a resting buy order", "value": { "purchaseId": "obLD1OX2BxgpOktcbX6PkA==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPurchaseResponse" }, "examples": { "fetch_completed_purchase": { "summary": "Fetch a completed purchase that has been received via Steam trade", "value": { "purchase": { "id": "MDEyMzQ1Njc4OWFiY2RlZg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "PURCHASE_STATUS_TRADED", "version": "5", "listingPriceCents": "4200", "maxBuyPriceCents": "5000", "platformFeeCents": "800", "listingId": "csfloat-listing-8731", "listingAssetId": "29384710293", "marketplace": "csfloat", "accountName": "trader_steam_01", "createdAt": "2026-04-10T08:30:00Z", "updatedAt": "2026-04-10T09:12:00Z" } } }, "fetch_flagged_trades_pending_purchase": { "summary": "Fetch a trade awaiting Steam delivery that reconciliation flagged for review", "value": { "purchase": { "id": "X049LBsKmYh3ZlVEMyIRAA==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "contractId": "yv66vt6tvu8BAgMEBQYHCA==", "marketHashName": "M4A1-S | Hyper Beast (Minimal Wear)", "status": "PURCHASE_STATUS_TRADES_PENDING", "version": "3", "listingPriceCents": "3175", "maxBuyPriceCents": "3500", "platformFeeCents": "325", "listingId": "csfloat-listing-90021", "listingAssetId": "41028573662", "marketplace": "csfloat", "strategy": "assignment", "accountName": "trader_steam_03", "createdAt": "2026-06-18T11:20:00Z", "updatedAt": "2026-06-20T03:00:00Z", "flaggedForReviewAt": "2026-06-21T00:15:00Z" } } }, "fetch_pending_buy_order_purchase": { "summary": "Fetch a pending purchase filled from a resting buy order", "value": { "purchase": { "id": "obLD1OX2BxgpOktcbX6PkA==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "contractId": "ABEiM0RVZneImaq7zN3u/w==", "marketHashName": "AWP | Asiimov (Field-Tested)", "status": "PURCHASE_STATUS_PENDING", "version": "1", "listingPriceCents": "8650", "maxBuyPriceCents": "9200", "platformFeeCents": "550", "referencePrices": [ { "referenceIndex": 0, "source": "market-csgo", "metric": "safe_price", "valueCents": "9000", "priceCents": "8730" }, { "referenceIndex": 1, "source": "steam-market", "metric": "median_price", "valueCents": "9500", "priceCents": "9200" } ], "listingId": "csfloat-listing-44219", "listingAssetId": "38172645091", "marketplace": "csfloat", "strategy": "buy_order", "accountName": "trader_steam_07", "createdAt": "2026-05-22T14:05:00Z", "updatedAt": "2026-05-22T14:05:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetPurchases": { "post": { "operationId": "contracts.v1.Contracts.GetPurchases", "summary": "Fetch multiple purchases by ID", "description": "Returns the purchases matching the given IDs within a workspace, alongside the IDs that did not resolve.", "tags": [ "Purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPurchasesRequest" }, "examples": { "get_purchases": { "summary": "Fetch multiple purchases by ID", "value": { "purchaseIds": [ "MDEyMzQ1Njc4OWFiY2RlZg==", "ZmVkY2JhOTg3NjU0MzIxMA==" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetPurchasesResponse" }, "examples": { "get_purchases": { "summary": "Fetch multiple purchases by ID", "value": { "purchases": [ { "id": "MDEyMzQ1Njc4OWFiY2RlZg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "PURCHASE_STATUS_TRADED", "version": "5", "listingPriceCents": "4200", "maxBuyPriceCents": "5000", "platformFeeCents": "800", "listingId": "csfloat-listing-8731", "listingAssetId": "29384710293", "marketplace": "csfloat", "accountName": "trader_steam_01", "createdAt": "2026-04-10T08:30:00Z", "updatedAt": "2026-04-10T09:12:00Z" } ], "notFoundIds": [ "ZmVkY2JhOTg3NjU0MzIxMA==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetSnapshot": { "post": { "operationId": "contracts.v1.Contracts.GetSnapshot", "summary": "Fetch a single contract snapshot by ID", "description": "Returns one evaluation snapshot of a contract, summarizing how many intents were added, updated, or removed and the total in effect. Snapshots bind an evaluation run to a fixed contract state.", "tags": [ "Snapshots" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetSnapshotRequest" }, "examples": { "get_snapshot": { "summary": "Fetch a single contract snapshot by ID", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotId": "7" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetSnapshotResponse" }, "examples": { "get_snapshot": { "summary": "Fetch a single contract snapshot by ID", "value": { "snapshot": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "id": "7", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "added": "42", "updated": "5", "deleted": "3", "total": "118", "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetSnapshots": { "post": { "operationId": "contracts.v1.Contracts.GetSnapshots", "summary": "Fetch multiple contract snapshots by ID", "description": "Returns the snapshots matching the given sequence numbers for a contract, alongside the IDs that did not resolve.", "tags": [ "Snapshots" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetSnapshotsRequest" }, "examples": { "get_snapshots": { "summary": "Fetch multiple contract snapshots by ID", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotIds": [ "7", "8" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetSnapshotsResponse" }, "examples": { "get_snapshots": { "summary": "Fetch multiple contract snapshots by ID", "value": { "snapshots": [ { "contractId": "EBESExQVFhcYGRobHB0eHw==", "id": "7", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "added": "42", "updated": "5", "deleted": "3", "total": "118", "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } ], "notFoundIds": [ "8" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetTransition": { "post": { "operationId": "contracts.v1.Contracts.GetTransition", "summary": "Fetch a single contract transition by ID", "description": "Returns one transition between two contract evaluation snapshots, recording how a single item changed (added, updated, or removed) from one snapshot to the next.", "tags": [ "Transitions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetTransitionRequest" }, "examples": { "get_transition": { "summary": "Fetch a single contract transition by ID", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "fromSnapshotId": "6", "toSnapshotId": "7", "transitionId": "dHJhbnNpdGlvbi0wMDAx" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetTransitionResponse" }, "examples": { "get_transition": { "summary": "Fetch a single contract transition by ID", "value": { "transition": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "fromSnapshotId": "6", "toSnapshotId": "7", "id": "dHJhbnNpdGlvbi0wMDAx", "type": "added", "marketHashName": "AK-47 | Redline (Field-Tested)", "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/GetTransitions": { "post": { "operationId": "contracts.v1.Contracts.GetTransitions", "summary": "Fetch multiple contract transitions by ID", "description": "Returns the transitions matching the given IDs between two contract snapshots, alongside the IDs that did not resolve.", "tags": [ "Transitions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetTransitionsRequest" }, "examples": { "get_transitions": { "summary": "Fetch multiple contract transitions by ID", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "fromSnapshotId": "6", "toSnapshotId": "7", "transitionIds": [ "dHJhbnNpdGlvbi0wMDAx", "dHJhbnNpdGlvbi0wMDAy" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.GetTransitionsResponse" }, "examples": { "get_transitions": { "summary": "Fetch multiple contract transitions by ID", "value": { "transitions": [ { "contractId": "EBESExQVFhcYGRobHB0eHw==", "fromSnapshotId": "6", "toSnapshotId": "7", "id": "dHJhbnNpdGlvbi0wMDAx", "type": "added", "marketHashName": "AK-47 | Redline (Field-Tested)", "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } ], "notFoundIds": [ "dHJhbnNpdGlvbi0wMDAy" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListAccountGroups": { "post": { "operationId": "contracts.v1.Contracts.ListAccountGroups", "summary": "List account groups", "description": "Returns a paged list of account groups. Each page carries hydrated entities, so no follow-up GetAccountGroups is needed.", "tags": [ "Account Groups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListAccountGroupsRequest" }, "examples": { "list_account_groups_empty_workspace": { "summary": "List account groups in an empty workspace", "value": { "limit": 100, "cursor": "" } }, "list_first_page_of_account_groups": { "summary": "List the first page of account groups", "value": { "limit": 50, "cursor": "" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListAccountGroupsResponse" }, "examples": { "list_account_groups_empty_workspace": { "summary": "List account groups in an empty workspace", "value": { "accountGroups": [], "nextCursor": "" } }, "list_first_page_of_account_groups": { "summary": "List the first page of account groups", "value": { "accountGroups": [ { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 Redline buyers", "members": [ "redline_trader_eu", "redline_trader_us", "float_hunter_01" ], "createdAt": "2026-03-12T08:30:00Z", "updatedAt": "2026-05-20T14:45:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListAssetIDLinks": { "post": { "operationId": "contracts.v1.Contracts.ListAssetIDLinks", "summary": "List the Steam asset ID chain for an inventory item", "description": "Returns the ordered chain of Steam asset IDs for a single inventory item, tracing each rotation across the three trade steps: the original listing, the purchase trade, and the sale trade. The chain is append-only and supports P\u0026L attribution across Steam's asset_id rotation on every trade.", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListAssetIDLinksRequest" }, "examples": { "empty_chain_no_links": { "summary": "Empty chain for an imported item with no recorded links", "value": { "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDc3", "limit": 50, "cursor": "" } }, "full_chain_sold_item": { "summary": "Full three-step chain for a sold item", "value": { "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDQy", "limit": 50, "cursor": "" } }, "list_chain_for_item": { "summary": "List every asset ID step for a single inventory item", "value": { "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDAx", "limit": 50, "cursor": "" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListAssetIDLinksResponse" }, "examples": { "empty_chain_no_links": { "summary": "Empty chain for an imported item with no recorded links", "value": { "assetIdLinks": [], "nextCursor": "" } }, "full_chain_sold_item": { "summary": "Full three-step chain for a sold item", "value": { "assetIdLinks": [ { "id": "bGluay0xMDE=", "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDQy", "purchaseId": "ZmVkY2JhOTg3NjU0MzIxMA==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "step": 0, "assetId": "35829471002", "previousAssetId": "", "source": "listing", "sourceId": "csfloat-listing-9920", "createdAt": "2026-05-02T14:05:00Z" }, { "id": "bGluay0xMDI=", "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDQy", "purchaseId": "ZmVkY2JhOTg3NjU0MzIxMA==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "step": 1, "assetId": "35829471888", "previousAssetId": "35829471002", "source": "purchase_trade", "sourceId": "trade-offer-5567", "createdAt": "2026-05-02T15:20:00Z" }, { "id": "bGluay0xMDM=", "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDQy", "purchaseId": "ZmVkY2JhOTg3NjU0MzIxMA==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "step": 2, "assetId": "35829472555", "previousAssetId": "35829471888", "source": "sale_trade", "sourceId": "trade-offer-6680", "createdAt": "2026-05-09T11:47:00Z" } ], "nextCursor": "" } }, "list_chain_for_item": { "summary": "List every asset ID step for a single inventory item", "value": { "assetIdLinks": [ { "id": "bGluay0wMDE=", "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDAx", "purchaseId": "MDEyMzQ1Njc4OWFiY2RlZg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "step": 0, "assetId": "29384710293", "previousAssetId": "", "source": "listing", "sourceId": "csfloat-listing-8731", "createdAt": "2026-04-10T08:30:00Z" }, { "id": "bGluay0wMDI=", "inventoryItemId": "aW52ZW50b3J5LWl0ZW0tMDAx", "purchaseId": "MDEyMzQ1Njc4OWFiY2RlZg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "step": 1, "assetId": "29384710999", "previousAssetId": "29384710293", "source": "purchase_trade", "sourceId": "trade-offer-4412", "createdAt": "2026-04-10T09:12:00Z" } ], "nextCursor": "" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListContracts": { "post": { "operationId": "contracts.v1.Contracts.ListContracts", "summary": "List contracts in a workspace", "description": "Returns a paged list of full contracts in the workspace, ordered by the requested sort field and direction. Filtering by contract type and by status, and sorting, are all applied server side, so the client passes the active tab and sort here rather than filtering a fetched page. Each page carries hydrated entities, so no follow-up GetContracts is needed.", "tags": [ "Contracts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListContractsRequest" }, "examples": { "list_active_buying_by_name": { "summary": "List active buying contracts, ordered by name", "value": { "limit": 50, "cursor": "", "type": "CONTRACT_TYPE_BUYING", "status": [ "CONTRACT_STATUS_ACTIVE", "CONTRACT_STATUS_BUILDING" ], "sortField": "CONTRACT_SORT_FIELD_NAME" } }, "list_drafts_empty": { "summary": "List draft selling contracts when none exist", "value": { "limit": 50, "cursor": "", "type": "CONTRACT_TYPE_SELLING", "status": [ "CONTRACT_STATUS_DRAFT" ] } }, "list_first_page": { "summary": "List the first page of contracts in a workspace", "value": { "limit": 50, "cursor": "" } }, "list_selling_by_recent": { "summary": "List selling contracts ordered by most recently updated", "value": { "limit": 25, "cursor": "", "type": "CONTRACT_TYPE_SELLING", "sortField": "CONTRACT_SORT_FIELD_UPDATED_AT", "descending": true } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListContractsResponse" }, "examples": { "list_active_buying_by_name": { "summary": "List active buying contracts, ordered by name", "value": { "contracts": [ { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 under $50", "status": "CONTRACT_STATUS_ACTIVE", "type": "CONTRACT_TYPE_BUYING", "version": "3" } ], "nextCursor": "" } }, "list_drafts_empty": { "summary": "List draft selling contracts when none exist", "value": { "contracts": [], "nextCursor": "" } }, "list_first_page": { "summary": "List the first page of contracts in a workspace", "value": { "contracts": [ { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 under $50", "status": "CONTRACT_STATUS_ACTIVE", "type": "CONTRACT_TYPE_BUYING", "version": "3" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } }, "list_selling_by_recent": { "summary": "List selling contracts ordered by most recently updated", "value": { "contracts": [ { "id": "ICEiIyQlJicoKSorLC0uLw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AWP | Asiimov resale", "description": "List held AWP | Asiimov (Field-Tested) skins at a 5 percent undercut on CSFloat.", "status": "CONTRACT_STATUS_ACTIVE", "type": "CONTRACT_TYPE_SELLING", "createdAt": "2026-03-15T14:30:00Z", "updatedAt": "2026-06-20T08:45:00Z", "version": "5", "snapshot": "11", "valuation": { "references": [ { "source": "buff163" } ], "strategy": "VALUATION_STRATEGY_AVG" }, "strategies": [ { "csfloatSell": { "undercutPct": 5, "priceSource": "buff163" } } ], "accountGroupId": "obLD1OX2BxgpOktcbX6PkA==" }, { "id": "MDEyMzQ1Njc4OTo7PD0+Pw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "StatTrak M4A1-S | Printstream", "description": "List StatTrak M4A1-S | Printstream (Minimal Wear) at a 3 percent undercut.", "status": "CONTRACT_STATUS_ACTIVE", "type": "CONTRACT_TYPE_SELLING", "createdAt": "2026-05-01T10:00:00Z", "updatedAt": "2026-06-18T16:20:00Z", "version": "2", "snapshot": "4" } ], "nextCursor": "eyJvZmZzZXQiOjI1fQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListFilterSets": { "post": { "operationId": "contracts.v1.Contracts.ListFilterSets", "summary": "List filter sets in a workspace", "description": "Returns a paged list of filter sets in the workspace. Each page carries hydrated entities, so no follow-up GetFilterSets is needed.", "tags": [ "Filter Sets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListFilterSetsRequest" }, "examples": { "list_filter_sets_empty_workspace": { "summary": "List filter sets in a workspace that has none", "value": { "limit": 50, "cursor": "" } }, "list_filter_sets_first_page_paginated": { "summary": "List the first page of filter sets when more pages remain", "value": { "limit": 3, "cursor": "" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListFilterSetsResponse" }, "examples": { "list_filter_sets_empty_workspace": { "summary": "List filter sets in a workspace that has none", "value": { "filterSets": [], "nextCursor": "" } }, "list_filter_sets_first_page_paginated": { "summary": "List the first page of filter sets when more pages remain", "value": { "filterSets": [ { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "StatTrak AK-47 Redline, Field-Tested or better", "description": "Reusable fragment matching StatTrak AK-47 Redline skins with a float of 0.27 or lower.", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_HAS_STAT_TRAK", "operator": "PREDICATE_OPERATOR_EQ", "value": { "boolValue": true } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.27 } } } ] } }, "version": "2", "createdAt": "2026-03-05T14:30:00Z", "updatedAt": "2026-04-18T08:45:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjN9" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListIntents": { "post": { "operationId": "contracts.v1.Contracts.ListIntents", "summary": "List contract intents in a snapshot", "description": "Returns a paged list of intents produced by one contract evaluation snapshot. Each page carries hydrated entities, so no follow-up GetIntents is needed.", "tags": [ "Intents" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListIntentsRequest" }, "examples": { "list_intents": { "summary": "List contract intents in a snapshot", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotId": "7", "limit": 100, "cursor": "" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListIntentsResponse" }, "examples": { "list_intents": { "summary": "List contract intents in a snapshot", "value": { "intents": [ { "contractId": "EBESExQVFhcYGRobHB0eHw==", "snapshotId": "7", "id": "aW50ZW50LWl0ZW0tMDAwMQ==", "marketHashName": "AK-47 | Redline (Field-Tested)", "maxBuyPriceCents": "4800", "maxFloat": 0.38, "referencePrices": [ { "referenceIndex": 0, "source": "buff163", "metric": "sell_min", "valueCents": "5000", "priceCents": "4800" } ], "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } ], "nextCursor": "" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListInventoryItems": { "post": { "operationId": "contracts.v1.Contracts.ListInventoryItems", "summary": "List inventory items in a workspace", "description": "Returns a paged list of inventory items owned by the workspace. Supports filtering by contract_id and lifecycle status. Each page carries hydrated entities, so no follow-up GetInventoryItems is needed.", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListInventoryItemsRequest" }, "examples": { "list_in_inventory": { "summary": "List items currently held in Steam inventory (not yet listed or sold)", "value": { "limit": 100, "cursor": "", "status": "INVENTORY_ITEM_STATUS_IN_INVENTORY" } }, "list_sellable_candidates_second_page": { "summary": "Page through sellable candidates excluding held items", "value": { "limit": 50, "cursor": "eyJvZmZzZXQiOjUwfQ==", "sellableOnly": true } }, "list_sold_items_for_contract": { "summary": "Filter sold items by contract returning an empty page", "value": { "limit": 100, "cursor": "", "contractId": "MDEyMzQ1Njc4OWFiY2RlZg==", "status": "INVENTORY_ITEM_STATUS_SOLD" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListInventoryItemsResponse" }, "examples": { "list_in_inventory": { "summary": "List items currently held in Steam inventory (not yet listed or sold)", "value": { "inventoryItems": [ { "id": "aW52ZW50b3J5LWl0ZW0tMDAx", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "purchaseId": "MDEyMzQ1Njc4OWFiY2RlZg==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "INVENTORY_ITEM_STATUS_IN_INVENTORY", "version": "2", "currentAssetId": "29384710999", "buyPriceCents": "4200", "tradable": true, "createdAt": "2026-04-10T09:12:00Z", "updatedAt": "2026-04-10T09:45:00Z" } ], "nextCursor": "" } }, "list_sellable_candidates_second_page": { "summary": "Page through sellable candidates excluding held items", "value": { "inventoryItems": [ { "id": "aW52ZW50b3J5LWl0ZW0tMDAx", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "purchaseId": "MDEyMzQ1Njc4OWFiY2RlZg==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "INVENTORY_ITEM_STATUS_IN_INVENTORY", "version": "2", "currentAssetId": "29384710999", "buyPriceCents": "4200", "tradable": true, "createdAt": "2026-04-10T09:12:00Z", "updatedAt": "2026-04-10T09:45:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjEwMH0=" } }, "list_sold_items_for_contract": { "summary": "Filter sold items by contract returning an empty page", "value": { "inventoryItems": [], "nextCursor": "" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListPurchases": { "post": { "operationId": "contracts.v1.Contracts.ListPurchases", "summary": "List purchases in a workspace", "description": "Returns a paged list of purchases in the workspace. Supports filtering by contract_id and lifecycle status. Each page carries hydrated entities, so no follow-up GetPurchases is needed.", "tags": [ "Purchases" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListPurchasesRequest" }, "examples": { "list_failed_purchases_empty": { "summary": "Filter by failed status with no matching purchases", "value": { "limit": 50, "cursor": "", "status": "PURCHASE_STATUS_FAILED" } }, "list_pending_purchases_for_contract": { "summary": "List pending purchases for a specific contract", "value": { "limit": 100, "cursor": "", "contractId": "EBESExQVFhcYGRobHB0eHw==", "status": "PURCHASE_STATUS_PENDING" } }, "list_recent_purchases": { "summary": "List the first page of purchases in a workspace", "value": { "limit": 100, "cursor": "" } }, "list_traded_purchases_next_page": { "summary": "Fetch the next page of traded purchases with a cursor", "value": { "limit": 100, "cursor": "eyJvZmZzZXQiOjEwMH0=", "status": "PURCHASE_STATUS_TRADED" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListPurchasesResponse" }, "examples": { "list_failed_purchases_empty": { "summary": "Filter by failed status with no matching purchases", "value": { "purchases": [], "nextCursor": "" } }, "list_pending_purchases_for_contract": { "summary": "List pending purchases for a specific contract", "value": { "purchases": [ { "id": "MDEyMzQ1Njc4OWFiY2RlZg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "PURCHASE_STATUS_TRADED", "version": "5", "listingPriceCents": "4200", "maxBuyPriceCents": "5000", "platformFeeCents": "800", "listingId": "csfloat-listing-8731", "listingAssetId": "29384710293", "marketplace": "csfloat", "accountName": "trader_steam_01", "createdAt": "2026-04-10T08:30:00Z", "updatedAt": "2026-04-10T09:12:00Z" } ], "nextCursor": "" } }, "list_recent_purchases": { "summary": "List the first page of purchases in a workspace", "value": { "purchases": [ { "id": "MDEyMzQ1Njc4OWFiY2RlZg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "PURCHASE_STATUS_TRADED", "version": "5", "listingPriceCents": "4200", "maxBuyPriceCents": "5000", "platformFeeCents": "800", "listingId": "csfloat-listing-8731", "listingAssetId": "29384710293", "marketplace": "csfloat", "accountName": "trader_steam_01", "createdAt": "2026-04-10T08:30:00Z", "updatedAt": "2026-04-10T09:12:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjEwMH0=" } }, "list_traded_purchases_next_page": { "summary": "Fetch the next page of traded purchases with a cursor", "value": { "purchases": [ { "id": "MDEyMzQ1Njc4OWFiY2RlZg==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "contractId": "EBESExQVFhcYGRobHB0eHw==", "marketHashName": "AK-47 | Redline (Field-Tested)", "status": "PURCHASE_STATUS_TRADED", "version": "5", "listingPriceCents": "4200", "maxBuyPriceCents": "5000", "platformFeeCents": "800", "listingId": "csfloat-listing-8731", "listingAssetId": "29384710293", "marketplace": "csfloat", "accountName": "trader_steam_01", "createdAt": "2026-04-10T08:30:00Z", "updatedAt": "2026-04-10T09:12:00Z" } ], "nextCursor": "" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListSnapshots": { "post": { "operationId": "contracts.v1.Contracts.ListSnapshots", "summary": "List contract snapshots", "description": "Returns a paged list of evaluation snapshots for a contract, most recent first. Each page carries hydrated entities, so no follow-up GetSnapshots is needed.", "tags": [ "Snapshots" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListSnapshotsRequest" }, "examples": { "list_snapshots": { "summary": "List contract snapshots", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "limit": 50, "cursor": "" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListSnapshotsResponse" }, "examples": { "list_snapshots": { "summary": "List contract snapshots", "value": { "snapshots": [ { "contractId": "EBESExQVFhcYGRobHB0eHw==", "id": "7", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "added": "42", "updated": "5", "deleted": "3", "total": "118", "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjN9" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListTransitions": { "post": { "operationId": "contracts.v1.Contracts.ListTransitions", "summary": "List contract transitions", "description": "Returns a paged list of transitions for a contract, optionally scoped to the changes between two specific snapshots. Each page carries hydrated entities, so no follow-up GetTransitions is needed.", "tags": [ "Transitions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListTransitionsRequest" }, "examples": { "list_transitions": { "summary": "List contract transitions", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "fromSnapshotId": "6", "toSnapshotId": "7", "limit": 100, "cursor": "" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListTransitionsResponse" }, "examples": { "list_transitions": { "summary": "List contract transitions", "value": { "transitions": [ { "contractId": "EBESExQVFhcYGRobHB0eHw==", "fromSnapshotId": "6", "toSnapshotId": "7", "id": "dHJhbnNpdGlvbi0wMDAx", "type": "added", "marketHashName": "AK-47 | Redline (Field-Tested)", "createdAt": "2026-04-01T12:15:00Z", "updatedAt": "2026-04-01T12:15:00Z" } ], "nextCursor": "" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/ListWorkspaceIntentRollup": { "post": { "operationId": "contracts.v1.Contracts.ListWorkspaceIntentRollup", "summary": "List this workspace's intent rollup for a side", "description": "Returns the workspace's own rolled-up buying or selling intents, one row per item and float window with the workspace's best price and the number of its contracts contributing. Only the caller's own rows are returned.", "tags": [ "Intents" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListWorkspaceIntentRollupRequest" }, "examples": { "list_workspace_intent_rollup": { "summary": "List this workspace's intent rollup for a side", "value": { "side": "buy", "limit": 50, "cursor": "" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.ListWorkspaceIntentRollupResponse" }, "examples": { "list_workspace_intent_rollup": { "summary": "List this workspace's intent rollup for a side", "value": { "items": [ { "marketHashName": "AK-47 | Redline (Field-Tested)", "side": "buy", "maxFloat": 0.38, "topPriceCents": "4800", "ownContributingCount": 2 }, { "marketHashName": "AWP | Asiimov (Field-Tested)", "side": "buy", "maxFloat": 0.38, "topPriceCents": "8730", "ownContributingCount": 1 } ], "nextCursor": "" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/UpdateAccountGroup": { "post": { "operationId": "contracts.v1.Contracts.UpdateAccountGroup", "summary": "Update an account group", "description": "Renames an account group or replaces its full membership. A non-empty members list replaces the group's accounts; an omitted or empty list leaves the membership unchanged.", "tags": [ "Account Groups" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.UpdateAccountGroupRequest" }, "examples": { "update_account_group": { "summary": "Update an account group", "value": { "accountGroupId": "EBESExQVFhcYGRobHB0eHw==", "name": "AK-47 Redline buyers (EU)", "members": [ "redline_trader_eu", "float_hunter_01", "float_hunter_02" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.UpdateAccountGroupResponse" }, "examples": { "update_account_group": { "summary": "Update an account group", "value": { "accountGroup": { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 Redline buyers (EU)", "members": [ "redline_trader_eu", "float_hunter_01", "float_hunter_02" ], "createdAt": "2026-03-12T08:30:00Z", "updatedAt": "2026-06-29T11:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/UpdateContract": { "post": { "operationId": "contracts.v1.Contracts.UpdateContract", "summary": "Update a contract", "description": "Applies partial edits to a contract, such as renaming it, changing its valuation or strategies, or activating and pausing it. Only the supplied fields are changed.", "tags": [ "Contracts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.UpdateContractRequest" }, "examples": { "update_contract": { "summary": "Update a contract", "value": { "contractId": "EBESExQVFhcYGRobHB0eHw==", "name": "AK-47 under $45", "valuation": { "references": [ { "source": "buff163", "metric": "sell_min" } ], "strategy": "VALUATION_STRATEGY_MIN" } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.UpdateContractResponse" }, "examples": { "update_contract": { "summary": "Update a contract", "value": { "contract": { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "AK-47 under $45", "description": "Buy any AK-47 skin priced below $50 on CSFloat.", "status": "CONTRACT_STATUS_ACTIVE", "type": "CONTRACT_TYPE_BUYING", "createdAt": "2026-02-10T09:00:00Z", "updatedAt": "2026-06-29T11:00:00Z", "version": "4", "snapshot": "7", "valuation": { "references": [ { "source": "buff163", "metric": "sell_min" } ], "strategy": "VALUATION_STRATEGY_MIN" } } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/contracts.v1.Contracts/UpdateFilterSet": { "post": { "operationId": "contracts.v1.Contracts.UpdateFilterSet", "summary": "Update a filter set", "description": "Applies partial edits to a filter set, such as renaming it or replacing its predicate fragment. Only the supplied fields are changed.", "tags": [ "Filter Sets" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.UpdateFilterSetRequest" }, "examples": { "update_filter_set": { "summary": "Update a filter set", "value": { "filterSetId": "EBESExQVFhcYGRobHB0eHw==", "name": "StatTrak AK-47 Redline, Minimal Wear or better", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_HAS_STAT_TRAK", "operator": "PREDICATE_OPERATOR_EQ", "value": { "boolValue": true } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.15 } } } ] } } } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contracts.v1.UpdateFilterSetResponse" }, "examples": { "update_filter_set": { "summary": "Update a filter set", "value": { "filterSet": { "id": "EBESExQVFhcYGRobHB0eHw==", "workspaceId": "AAECAwQFBgcICQoLDA0ODw==", "name": "StatTrak AK-47 Redline, Minimal Wear or better", "description": "Reusable fragment matching StatTrak AK-47 Redline skins with a float of 0.27 or lower.", "predicate": { "group": { "condition": "PREDICATE_CONDITION_AND", "rules": [ { "rule": { "field": "PREDICATE_FIELD_WEAPON", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "AK-47" } } }, { "rule": { "field": "PREDICATE_FIELD_PAINT", "operator": "PREDICATE_OPERATOR_EQ", "value": { "stringValue": "Redline" } } }, { "rule": { "field": "PREDICATE_FIELD_HAS_STAT_TRAK", "operator": "PREDICATE_OPERATOR_EQ", "value": { "boolValue": true } } }, { "rule": { "field": "PREDICATE_FIELD_MAX_WEAR", "operator": "PREDICATE_OPERATOR_LTE", "value": { "numberValue": 0.15 } } } ] } }, "version": "3", "createdAt": "2026-03-05T14:30:00Z", "updatedAt": "2026-06-29T11:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/BulkAssignAccountsToPool": { "post": { "operationId": "proxies.v1.Proxies.BulkAssignAccountsToPool", "summary": "Assign many accounts to a proxy pool", "description": "Binds many accounts to a proxy pool in one call so a workspace's accounts start using its proxies. Each account is bound to the pool and the specific proxy is chosen automatically on first use, so you never pick a session. An account already bound to the pool is left as is, and an account bound to a different pool is moved to this one. The response reports how many accounts are now bound to the pool.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.BulkAssignAccountsToPoolRequest" }, "examples": { "bulk_assign_accounts_to_pool": { "summary": "Assign many accounts to a proxy pool", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==", "accountNames": [ "steam_bot_01", "steam_bot_02", "steam_bot_03" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.BulkAssignAccountsToPoolResponse" }, "examples": { "bulk_assign_accounts_to_pool": { "summary": "Assign many accounts to a proxy pool", "value": { "assignedCount": 3 } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/BulkCreateAssignment": { "post": { "operationId": "proxies.v1.Proxies.BulkCreateAssignment", "summary": "Create many proxy assignments", "description": "Binds many accounts to proxy sessions in one call. Each row is committed independently and the response reports per-row success or a typed error, so one bad row does not fail the whole batch.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.BulkCreateAssignmentRequest" }, "examples": { "bulk_create_assignment": { "summary": "Create many proxy assignments", "value": { "assignments": [ { "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "accountName": "steam_bot_01", "pinned": true }, { "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIkREeqqLu19fX19fXw==", "accountName": "steam_bot_02" } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.BulkCreateAssignmentResponse" }, "examples": { "bulk_create_assignment": { "summary": "Create many proxy assignments", "value": { "results": [ { "assignmentId": "AY+MI0REf/+Kql9fX19fXw==" }, { "error": { "code": "BULK_CREATE_ASSIGNMENT_ERROR_CODE_ALREADY_EXISTS", "message": "assignment already exists for this pool and account" } } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/BulkCreateSessions": { "post": { "operationId": "proxies.v1.Proxies.BulkCreateSessions", "summary": "Create many proxy sessions", "description": "Adds many proxy sessions to one imported (provider-less) pool in a single transaction, typically when seeding a pool. The operation is idempotent on the pool and session token, so re-running it does not create duplicates.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.BulkCreateSessionsRequest" }, "examples": { "bulk_create_sessions": { "summary": "Create many proxy sessions", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessions": [ { "token": "sess-1", "scheme": "http", "host": "203.0.113.10", "port": 8080, "username": "u1", "password": "p1" }, { "token": "sess-2", "scheme": "socks5", "host": "203.0.113.11", "port": 1080, "username": "u2", "password": "p2" } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.BulkCreateSessionsResponse" }, "examples": { "bulk_create_sessions": { "summary": "Create many proxy sessions", "value": { "sessions": [ { "id": "AY+MIjMzfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "token": "sess-1", "scheme": "http", "host": "203.0.113.10", "port": 8080, "username": "u1", "enabled": true, "version": "1", "createdAt": "2026-06-29T10:15:00Z", "updatedAt": "2026-06-29T10:15:00Z" }, { "id": "AY+MIkREeqqLu19fX19fXw==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "token": "sess-2", "scheme": "socks5", "host": "203.0.113.11", "port": 1080, "username": "u2", "enabled": true, "version": "1", "createdAt": "2026-06-29T10:15:00Z", "updatedAt": "2026-06-29T10:15:00Z" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ConnectProvider": { "post": { "operationId": "proxies.v1.Proxies.ConnectProvider", "summary": "Connect a proxy provider", "description": "Connects a credential-bearing proxy backend such as a Webshare or Proxyline account to your workspace. Credentials are sent in plaintext and encrypted before storage, and only one connection of each provider type is allowed per workspace.", "tags": [ "Providers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ConnectProviderRequest" }, "examples": { "connect_provider": { "summary": "Connect a proxy provider", "value": { "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "credentials": "d2Vic2hhcmUtdG9rZW4tQWJDZEVmMTIzNDU2" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ConnectProviderResponse" }, "examples": { "connect_provider": { "summary": "Connect a proxy provider", "value": { "provider": { "id": "AY+MIBEReqqLuywsLCwsLA==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "targetPoolId": "AY+MISIifMyN3T09PT09PQ==", "capabilities": { "enumerable": true, "stateApi": true }, "enabled": true, "version": "1", "createdAt": "2026-06-29T10:15:00Z", "updatedAt": "2026-06-29T10:15:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CountAssignments": { "post": { "operationId": "proxies.v1.Proxies.CountAssignments", "summary": "Count proxy assignments", "description": "Returns the number of proxy assignments in your workspace, optionally filtered by pool, session, or account name, so a list page can render a count without loading and counting every row.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountAssignmentsRequest" }, "examples": { "count_assignments": { "summary": "Count proxy assignments in a pool", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountAssignmentsResponse" }, "examples": { "count_assignments": { "summary": "Count proxy assignments in a pool", "value": { "count": 2 } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CountPools": { "post": { "operationId": "proxies.v1.Proxies.CountPools", "summary": "Count proxy pools", "description": "Returns the number of proxy pools in your workspace, so a list page can render a count without loading and counting every row.", "tags": [ "Pools" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountPoolsRequest" }, "examples": { "count_pools": { "summary": "Count proxy pools in the workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountPoolsResponse" }, "examples": { "count_pools": { "summary": "Count proxy pools in the workspace", "value": { "count": 2 } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CountProviders": { "post": { "operationId": "proxies.v1.Proxies.CountProviders", "summary": "Count proxy providers", "description": "Returns the number of proxy providers connected to your workspace, so a list page can render a count without loading and counting every row.", "tags": [ "Providers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountProvidersRequest" }, "examples": { "count_providers": { "summary": "Count proxy providers in the workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountProvidersResponse" }, "examples": { "count_providers": { "summary": "Count proxy providers in the workspace", "value": { "count": 2 } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CountRemediations": { "post": { "operationId": "proxies.v1.Proxies.CountRemediations", "summary": "Count proxy remediation records", "description": "Returns the number of proxy remediation records in your workspace, optionally filtered by pool or status, so a list page can render a count without loading and counting every row.", "tags": [ "Remediations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountRemediationsRequest" }, "examples": { "count_remediations": { "summary": "Count proxy remediation records in the workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountRemediationsResponse" }, "examples": { "count_remediations": { "summary": "Count proxy remediation records in the workspace", "value": { "count": 2 } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CountRenewals": { "post": { "operationId": "proxies.v1.Proxies.CountRenewals", "summary": "Count proxy renewal episodes", "description": "Returns the number of proxy renewal episodes in your workspace, optionally filtered by provider or status, so a list page can render a count without loading and counting every row.", "tags": [ "Renewals" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountRenewalsRequest" }, "examples": { "count_renewals": { "summary": "Count proxy renewal episodes in the workspace", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountRenewalsResponse" }, "examples": { "count_renewals": { "summary": "Count proxy renewal episodes in the workspace", "value": { "count": 2 } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CountSessions": { "post": { "operationId": "proxies.v1.Proxies.CountSessions", "summary": "Count proxy sessions", "description": "Returns the number of proxy sessions in your workspace, optionally limited to a single pool, so a list page can render a count without loading and counting every row.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountSessionsRequest" }, "examples": { "count_sessions": { "summary": "Count proxy sessions in a pool", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CountSessionsResponse" }, "examples": { "count_sessions": { "summary": "Count proxy sessions in a pool", "value": { "count": 3 } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CreateAssignment": { "post": { "operationId": "proxies.v1.Proxies.CreateAssignment", "summary": "Create a proxy assignment", "description": "Binds an account to a specific proxy session within a pool so the account consistently uses that proxy. Pinning the assignment keeps the account on its session even when the session is disabled.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CreateAssignmentRequest" }, "examples": { "create_assignment": { "summary": "Create a proxy assignment", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "accountName": "steam_bot_01", "pinned": true } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CreateAssignmentResponse" }, "examples": { "create_assignment": { "summary": "Create a proxy assignment", "value": { "assignment": { "id": "AY+MI0REf/+Kql9fX19fXw==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "accountName": "steam_bot_01", "pinned": true, "version": "1", "createdAt": "2026-06-29T10:15:00Z", "updatedAt": "2026-06-29T10:15:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/CreateSession": { "post": { "operationId": "proxies.v1.Proxies.CreateSession", "summary": "Create a proxy session", "description": "Adds a single proxy session to an imported (provider-less) pool - targeting a provider-owned pool is rejected, since that pool's sessions come from its provider's own write path. For static endpoints you provide the scheme, host, port, and credentials; rotation sessions carry only a sticky-session token. The endpoint password is write only and never returned.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CreateSessionRequest" }, "examples": { "create_session": { "summary": "Create a proxy session", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==", "token": "sess-abc123", "scheme": "http", "host": "203.0.113.10", "port": 8080, "username": "user-018f", "password": "s3cr3t-pass" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.CreateSessionResponse" }, "examples": { "create_session": { "summary": "Create a proxy session", "value": { "session": { "id": "AY+MIjMzfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "token": "sess-abc123", "scheme": "http", "host": "203.0.113.10", "port": 8080, "username": "user-018f", "enabled": true, "version": "1", "createdAt": "2026-06-29T10:15:00Z", "updatedAt": "2026-06-29T10:15:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/DeleteAssignment": { "post": { "operationId": "proxies.v1.Proxies.DeleteAssignment", "summary": "Delete a proxy assignment", "description": "Removes a proxy assignment, unbinding the account from its session. The assignment is soft deleted.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.DeleteAssignmentRequest" }, "examples": { "delete_assignment": { "summary": "Delete a proxy assignment", "value": { "assignmentId": "AY+MI0REf/+Kql9fX19fXw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.DeleteAssignmentResponse" }, "examples": { "delete_assignment": { "summary": "Delete a proxy assignment", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/DeleteProvider": { "post": { "operationId": "proxies.v1.Proxies.DeleteProvider", "summary": "Delete a proxy provider", "description": "Removes a connected proxy provider from your workspace. The provider is soft deleted and stops contributing proxies to its pools.", "tags": [ "Providers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.DeleteProviderRequest" }, "examples": { "delete_provider": { "summary": "Delete a proxy provider", "value": { "providerId": "AY+MIBEReqqLuywsLCwsLA==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.DeleteProviderResponse" }, "examples": { "delete_provider": { "summary": "Delete a proxy provider", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/DeleteSession": { "post": { "operationId": "proxies.v1.Proxies.DeleteSession", "summary": "Delete a proxy session", "description": "Removes a proxy session from its pool. The session is soft deleted and excluded from future proxy resolution.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.DeleteSessionRequest" }, "examples": { "delete_session": { "summary": "Delete a proxy session", "value": { "sessionId": "AY+MIjMzfu6P/05OTk5OTg==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.DeleteSessionResponse" }, "examples": { "delete_session": { "summary": "Delete a proxy session", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/GetAssignment": { "post": { "operationId": "proxies.v1.Proxies.GetAssignment", "summary": "Get a proxy assignment", "description": "Returns a single proxy assignment, showing which account is bound to which session and whether it is pinned.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetAssignmentRequest" }, "examples": { "get_assignment": { "summary": "Get a proxy assignment", "value": { "assignmentId": "AY+MI0REf/+Kql9fX19fXw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetAssignmentResponse" }, "examples": { "get_assignment": { "summary": "Get a proxy assignment", "value": { "assignment": { "id": "AY+MI0REf/+Kql9fX19fXw==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "accountName": "steam_bot_01", "pinned": true, "version": "1", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-20T12:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/GetPool": { "post": { "operationId": "proxies.v1.Proxies.GetPool", "summary": "Get a proxy pool", "description": "Returns a single proxy pool with its configuration, capacity caps, and health-probe settings.", "tags": [ "Pools" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetPoolRequest" }, "examples": { "get_pool": { "summary": "Get a proxy pool", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetPoolResponse" }, "examples": { "get_pool": { "summary": "Get a proxy pool", "value": { "pool": { "id": "AY+MISIifMyN3T09PT09PQ==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "name": "csfloat-scrapers", "description": "Residential pool for csfloat scraping", "sessionCount": 50, "autoRotateUnhealthy": true, "version": "3", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T09:00:00Z", "maxSessions": 200, "maxAssignmentsPerSession": 1, "probeInterval": "300s", "unhealthyAfterFailures": 3, "probeLatencyCeiling": "5s" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/GetProvider": { "post": { "operationId": "proxies.v1.Proxies.GetProvider", "summary": "Get a proxy provider", "description": "Returns a single connected proxy provider, including its capabilities and the most recent snapshot of its upstream plan and bandwidth state. Stored credentials are never returned.", "tags": [ "Providers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetProviderRequest" }, "examples": { "get_provider": { "summary": "Get a proxy provider", "value": { "providerId": "AY+MIBEReqqLuywsLCwsLA==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetProviderResponse" }, "examples": { "get_provider": { "summary": "Get a proxy provider", "value": { "provider": { "id": "AY+MIBEReqqLuywsLCwsLA==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "targetPoolId": "AY+MISIifMyN3T09PT09PQ==", "capabilities": { "enumerable": true, "stateApi": true }, "state": { "bandwidthLimitBytes": "1099511627776", "bandwidthUsedBytes": "21474836480", "plan": "residential-1tb", "geoCount": 195 }, "stateRefreshedAt": "2026-06-29T09:00:00Z", "enabled": true, "version": "3", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T09:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/GetRemediation": { "post": { "operationId": "proxies.v1.Proxies.GetRemediation", "summary": "Get a proxy remediation record", "description": "Returns an account's endpoint-replacement remediation record, if it has ever had one, showing its status, the pool and provider it is chasing a fresh endpoint for, and spend so far.", "tags": [ "Remediations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetRemediationRequest" }, "examples": { "get_remediation": { "summary": "Get a proxy remediation record", "value": { "accountName": "steam_bot_01" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetRemediationResponse" }, "examples": { "get_remediation": { "summary": "Get a proxy remediation record", "value": { "remediation": { "id": "AY+MJmRlZu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "assignmentId": "AY+MI0REf/+Kql9fX19fXw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "accountName": "steam_bot_01", "status": "ACQUIRING", "attempts": 1, "spendCents": "500", "createdAt": "2026-06-29T09:00:00Z", "updatedAt": "2026-06-29T09:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/GetRenewal": { "post": { "operationId": "proxies.v1.Proxies.GetRenewal", "summary": "Get a proxy renewal episode", "description": "Returns a single provider renewal episode by id, showing its status, the endpoint batch it renews, and spend so far.", "tags": [ "Renewals" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetRenewalRequest" }, "examples": { "get_renewal": { "summary": "Get a proxy renewal episode", "value": { "renewalId": "AY+MJmZmfu6P/05OTk5OTg==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetRenewalResponse" }, "examples": { "get_renewal": { "summary": "Get a proxy renewal episode", "value": { "renewal": { "id": "AY+MJmZmfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "providerId": "AY+MIZmZfu6P/05OTk5OTg==", "status": "RENEWING", "endpointIds": [ "10.0.0.1:8080", "10.0.0.2:8080" ], "attempts": 1, "spendCents": "2500", "createdAt": "2026-06-29T09:00:00Z", "updatedAt": "2026-06-29T09:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/GetSession": { "post": { "operationId": "proxies.v1.Proxies.GetSession", "summary": "Get a proxy session", "description": "Returns a single proxy session with its endpoint details and status. The session password is never returned.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetSessionRequest" }, "examples": { "get_session": { "summary": "Get a proxy session", "value": { "sessionId": "AY+MIjMzfu6P/05OTk5OTg==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.GetSessionResponse" }, "examples": { "get_session": { "summary": "Get a proxy session", "value": { "session": { "id": "AY+MIjMzfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "providerId": "AY+MIBEReqqLuywsLCwsLA==", "token": "sess-abc123", "scheme": "http", "host": "203.0.113.10", "port": 8080, "username": "user-018f", "enabled": true, "version": "2", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T09:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ImportProxyList": { "post": { "operationId": "proxies.v1.Proxies.ImportProxyList", "summary": "Import a proxy list into a pool", "description": "Turns an uploaded list of proxies into ready-to-use sessions in one call. It creates a new provider-less pool by name and inserts one session per row directly into it - there is no provider and no existing-pool option. Each row is processed independently and the response reports per-row success or error.", "tags": [ "Import" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ImportProxyListRequest" }, "examples": { "import_proxy_list": { "summary": "Import a proxy list into a pool", "value": { "poolName": "imported-proxies", "rows": [ { "scheme": "http", "host": "203.0.113.10", "port": 8080, "username": "u1", "password": "p1" }, { "scheme": "socks5", "host": "203.0.113.11", "port": 1080 } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ImportProxyListResponse" }, "examples": { "import_proxy_list": { "summary": "Import a proxy list into a pool", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==", "results": [ { "sessionId": "AY+MIjMzfu6P/05OTk5OTg==" }, { "error": { "code": "IMPORT_PROXY_LIST_ERROR_CODE_INVALID", "message": "invalid host" } } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ListAssignments": { "post": { "operationId": "proxies.v1.Proxies.ListAssignments", "summary": "List proxy assignments", "description": "Returns the proxy assignments in your workspace, fully hydrated, optionally filtered by pool, session, or account name. Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListAssignmentsRequest" }, "examples": { "list_assignments": { "summary": "List proxy assignments", "value": { "limit": 50, "poolId": "AY+MISIifMyN3T09PT09PQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListAssignmentsResponse" }, "examples": { "list_assignments": { "summary": "List proxy assignments", "value": { "assignments": [ { "id": "AY+MI0REf/+Kql9fX19fXw==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "accountName": "steam_bot_01", "pinned": true, "version": "1", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-20T12:00:00Z" }, { "id": "AY+MJTU1NTU1NTU1NTU1NQ==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MJTQ0NDQ0NDQ0NDQ0NA==", "accountName": "steam_bot_02", "version": "1", "createdAt": "2026-06-30T14:00:00Z", "updatedAt": "2026-06-30T14:00:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ListPools": { "post": { "operationId": "proxies.v1.Proxies.ListPools", "summary": "List proxy pools", "description": "Returns the proxy pools in your workspace, fully hydrated with their configuration and server-computed proxy_count. Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.", "tags": [ "Pools" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListPoolsRequest" }, "examples": { "list_pools": { "summary": "List proxy pools", "value": { "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListPoolsResponse" }, "examples": { "list_pools": { "summary": "List proxy pools", "value": { "pools": [ { "id": "AY+MISIifMyN3T09PT09PQ==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "name": "csfloat-scrapers", "description": "Residential pool for csfloat scraping", "sessionCount": 50, "autoRotateUnhealthy": true, "version": "3", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T09:00:00Z", "maxSessions": 200, "maxAssignmentsPerSession": 1, "probeInterval": "300s", "unhealthyAfterFailures": 3, "probeLatencyCeiling": "5s", "proxyCount": 2 }, { "id": "AY+MJTIyMjIyMjIyMjIyMg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "name": "steam-real-accounts", "description": "Static proxies for steam account logins", "maxSessions": 200, "proxyCount": 45, "version": "2", "createdAt": "2026-06-22T08:00:00Z", "updatedAt": "2026-06-29T07:30:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ListProviders": { "post": { "operationId": "proxies.v1.Proxies.ListProviders", "summary": "List proxy providers", "description": "Returns the proxy providers connected to your workspace, fully hydrated (the encrypted credential fields are omitted, exactly as GetProvider omits them). Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.", "tags": [ "Providers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListProvidersRequest" }, "examples": { "list_providers": { "summary": "List proxy providers", "value": { "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListProvidersResponse" }, "examples": { "list_providers": { "summary": "List proxy providers", "value": { "providers": [ { "id": "AY+MIBEReqqLuywsLCwsLA==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "targetPoolId": "AY+MISIifMyN3T09PT09PQ==", "capabilities": { "enumerable": true, "stateApi": true }, "state": { "bandwidthLimitBytes": "1099511627776", "bandwidthUsedBytes": "21474836480", "plan": "residential-1tb", "geoCount": 195 }, "stateRefreshedAt": "2026-06-29T09:00:00Z", "enabled": true, "version": "3", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T09:00:00Z" }, { "id": "AY+MIZmZfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "type": "PROVIDER_TYPE_PROXYLINE", "targetPoolId": "AY+MJTMzMzMzMzMzMzMzMw==", "capabilities": { "staticExitIp": true, "enumerable": true, "stateApi": true, "supportsSocks5": true }, "state": { "bandwidthUsedBytes": "5368709120", "plan": "proxyline-flex", "geoCount": 80 }, "stateRefreshedAt": "2026-06-29T08:45:00Z", "enabled": true, "version": "1", "createdAt": "2026-06-25T09:00:00Z", "updatedAt": "2026-06-29T08:45:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ListRemediations": { "post": { "operationId": "proxies.v1.Proxies.ListRemediations", "summary": "List proxy remediation records", "description": "Returns the proxy remediation records in your workspace, optionally filtered by pool or status. Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.", "tags": [ "Remediations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListRemediationsRequest" }, "examples": { "list_remediations": { "summary": "List proxy remediation records", "value": { "limit": 50, "poolId": "AY+MISIifMyN3T09PT09PQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListRemediationsResponse" }, "examples": { "list_remediations": { "summary": "List proxy remediation records", "value": { "remediations": [ { "id": "AY+MJmRlZu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "assignmentId": "AY+MI0REf/+Kql9fX19fXw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "accountName": "steam_bot_01", "status": "HALTED", "attempts": 3, "spendCents": "0", "lastError": "no healthy candidate available", "createdAt": "2026-06-28T09:00:00Z", "updatedAt": "2026-06-28T09:05:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ListRenewals": { "post": { "operationId": "proxies.v1.Proxies.ListRenewals", "summary": "List proxy renewal episodes", "description": "Returns the proxy renewal episodes in your workspace, optionally filtered by provider or status. Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.", "tags": [ "Renewals" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListRenewalsRequest" }, "examples": { "list_renewals": { "summary": "List proxy renewal episodes", "value": { "limit": 50, "providerId": "AY+MIZmZfu6P/05OTk5OTg==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListRenewalsResponse" }, "examples": { "list_renewals": { "summary": "List proxy renewal episodes", "value": { "renewals": [ { "id": "AY+MJmZmfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "providerId": "AY+MIZmZfu6P/05OTk5OTg==", "status": "HALTED", "endpointIds": [ "10.0.0.1:8080" ], "attempts": 3, "spendCents": "0", "lastError": "insufficient balance", "createdAt": "2026-06-28T09:00:00Z", "updatedAt": "2026-06-28T09:05:00Z" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/ListSessions": { "post": { "operationId": "proxies.v1.Proxies.ListSessions", "summary": "List proxy sessions", "description": "Returns the proxy sessions in your workspace, fully hydrated with their endpoint details and latest health verdict, optionally limited to a single pool. Results are paginated; pass an empty cursor for the first page and follow the returned cursor for subsequent pages.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListSessionsRequest" }, "examples": { "list_sessions": { "summary": "List proxy sessions", "value": { "limit": 50, "poolId": "AY+MISIifMyN3T09PT09PQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.ListSessionsResponse" }, "examples": { "list_sessions": { "summary": "List proxy sessions", "value": { "sessions": [ { "id": "AY+MIjMzfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "providerId": "AY+MIBEReqqLuywsLCwsLA==", "token": "sess-abc123", "scheme": "http", "host": "203.0.113.10", "port": 8080, "username": "user-018f", "enabled": true, "version": "2", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T09:00:00Z", "health": { "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "healthy": true, "latencyMs": 42, "consecutiveFailures": 0, "lastSuccessAt": "2026-06-29T09:05:00Z", "probedAt": "2026-06-29T09:05:00Z" } }, { "id": "AY+MJTQ0NDQ0NDQ0NDQ0NA==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "providerId": "AY+MIBEReqqLuywsLCwsLA==", "token": "7", "enabled": true, "version": "1", "createdAt": "2026-06-30T14:00:00Z", "updatedAt": "2026-06-30T14:00:00Z", "health": { "sessionId": "AY+MJTQ0NDQ0NDQ0NDQ0NA==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "healthy": true, "latencyMs": 88, "consecutiveFailures": 0, "lastSuccessAt": "2026-06-30T14:05:00Z", "probedAt": "2026-06-30T14:05:00Z" }, "slot": 7 } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/QueryProxyUsage": { "post": { "operationId": "proxies.v1.Proxies.QueryProxyUsage", "summary": "Query proxy bandwidth usage", "description": "Returns the proxy bandwidth ledger over an inclusive date range, optionally narrowed by provider, pool, session, or account. Each row is a daily total of requests, errors, and bytes transferred. Results are paginated; follow the returned cursor for subsequent pages.", "tags": [ "Usage" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.QueryProxyUsageRequest" }, "examples": { "query_proxy_usage": { "summary": "Query proxy bandwidth usage", "value": { "startDate": "2026-06-01", "endDate": "2026-06-29", "poolId": "AY+MISIifMyN3T09PT09PQ==", "limit": 100 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.QueryProxyUsageResponse" }, "examples": { "query_proxy_usage": { "summary": "Query proxy bandwidth usage", "value": { "records": [ { "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "providerId": "AY+MIBEReqqLuywsLCwsLA==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "accountName": "steam_bot_01", "usageDate": "2026-06-15", "requestCount": "1500", "errorCount": "12", "bytesOut": "5242880", "bytesIn": "104857600" } ], "nextCursor": "eyJvZmZzZXQiOjUwfQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/RebindAllAssignmentsInPool": { "post": { "operationId": "proxies.v1.Proxies.RebindAllAssignmentsInPool", "summary": "Rebind all assignments in a pool", "description": "Moves every unpinned assignment in a pool to a freshly chosen healthy session. Returns the identifiers of the assignments that actually changed session.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.RebindAllAssignmentsInPoolRequest" }, "examples": { "rebind_all_assignments_in_pool": { "summary": "Rebind all assignments in a pool", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.RebindAllAssignmentsInPoolResponse" }, "examples": { "rebind_all_assignments_in_pool": { "summary": "Rebind all assignments in a pool", "value": { "assignmentIds": [ "AY+MI0REf/+Kql9fX19fXw==", "AY+MI1VVe7uMzGpqampqag==" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/RebindAssignment": { "post": { "operationId": "proxies.v1.Proxies.RebindAssignment", "summary": "Rebind a proxy assignment", "description": "Moves an assignment to a freshly chosen healthy session in the same pool, ignoring the pool's auto-rotation policy. Pinned assignments are rejected and must be unpinned first.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.RebindAssignmentRequest" }, "examples": { "rebind_assignment": { "summary": "Rebind a proxy assignment", "value": { "assignmentId": "AY+MI0REf/+Kql9fX19fXw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.RebindAssignmentResponse" }, "examples": { "rebind_assignment": { "summary": "Rebind a proxy assignment", "value": { "assignment": { "id": "AY+MI0REf/+Kql9fX19fXw==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIkREeqqLu19fX19fXw==", "accountName": "steam_bot_01", "version": "3", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T11:30:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/RefreshProviderState": { "post": { "operationId": "proxies.v1.Proxies.RefreshProviderState", "summary": "Refresh a proxy provider's state", "description": "Pulls the latest plan and bandwidth usage from the provider's upstream account and returns the refreshed provider. Only providers that expose an account state interface can be refreshed.", "tags": [ "Providers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.RefreshProviderStateRequest" }, "examples": { "refresh_provider_state": { "summary": "Refresh a proxy provider's state", "value": { "providerId": "AY+MIBEReqqLuywsLCwsLA==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.RefreshProviderStateResponse" }, "examples": { "refresh_provider_state": { "summary": "Refresh a proxy provider's state", "value": { "provider": { "id": "AY+MIBEReqqLuywsLCwsLA==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "targetPoolId": "AY+MISIifMyN3T09PT09PQ==", "capabilities": { "enumerable": true, "stateApi": true }, "state": { "bandwidthLimitBytes": "1099511627776", "bandwidthUsedBytes": "23622320128", "plan": "residential-1tb", "geoCount": 195 }, "stateRefreshedAt": "2026-06-29T11:30:00Z", "enabled": true, "version": "5", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T11:30:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/UpdateAssignment": { "post": { "operationId": "proxies.v1.Proxies.UpdateAssignment", "summary": "Update a proxy assignment", "description": "Updates a proxy assignment, such as rebinding the account to a different session or changing whether it is pinned. Only the fields you supply are changed.", "tags": [ "Assignments" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdateAssignmentRequest" }, "examples": { "update_assignment": { "summary": "Update a proxy assignment", "value": { "assignmentId": "AY+MI0REf/+Kql9fX19fXw==", "sessionId": "AY+MIkREeqqLu19fX19fXw==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdateAssignmentResponse" }, "examples": { "update_assignment": { "summary": "Update a proxy assignment", "value": { "assignment": { "id": "AY+MI0REf/+Kql9fX19fXw==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionId": "AY+MIkREeqqLu19fX19fXw==", "accountName": "steam_bot_01", "pinned": true, "version": "2", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T11:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/UpdatePool": { "post": { "operationId": "proxies.v1.Proxies.UpdatePool", "summary": "Update a proxy pool", "description": "Updates a proxy pool's name, description, slot count, auto-rotation behavior, capacity caps, or health-probe settings. Only the fields you supply are changed.", "tags": [ "Pools" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdatePoolRequest" }, "examples": { "update_pool": { "summary": "Update a proxy pool", "value": { "poolId": "AY+MISIifMyN3T09PT09PQ==", "sessionCount": 75, "autoRotateUnhealthy": true } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdatePoolResponse" }, "examples": { "update_pool": { "summary": "Update a proxy pool", "value": { "pool": { "id": "AY+MISIifMyN3T09PT09PQ==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "name": "csfloat-scrapers", "description": "Residential pool for csfloat scraping", "sessionCount": 75, "autoRotateUnhealthy": true, "version": "4", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T11:00:00Z", "maxSessions": 200, "maxAssignmentsPerSession": 1, "probeInterval": "300s", "unhealthyAfterFailures": 3, "probeLatencyCeiling": "5s" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/UpdateProvider": { "post": { "operationId": "proxies.v1.Proxies.UpdateProvider", "summary": "Update a proxy provider", "description": "Updates a connected proxy provider. You can enable or disable it, or rotate its credentials. Only the fields you supply are changed.", "tags": [ "Providers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdateProviderRequest" }, "examples": { "update_provider": { "summary": "Update a proxy provider", "value": { "providerId": "AY+MIBEReqqLuywsLCwsLA==", "credentials": "d2Vic2hhcmUtdG9rZW4tcm90YXRlZC0yMDI2" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdateProviderResponse" }, "examples": { "update_provider": { "summary": "Update a proxy provider", "value": { "provider": { "id": "AY+MIBEReqqLuywsLCwsLA==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "type": "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "targetPoolId": "AY+MISIifMyN3T09PT09PQ==", "capabilities": { "enumerable": true, "stateApi": true }, "state": { "bandwidthLimitBytes": "1099511627776", "bandwidthUsedBytes": "21474836480", "plan": "residential-1tb", "geoCount": 195 }, "stateRefreshedAt": "2026-06-29T09:00:00Z", "enabled": true, "version": "4", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T11:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/proxies.v1.Proxies/UpdateSession": { "post": { "operationId": "proxies.v1.Proxies.UpdateSession", "summary": "Update a proxy session", "description": "Updates a proxy session, such as disabling it to trim a pool or changing a static endpoint's host, port, or username. Only the fields you supply are changed.", "tags": [ "Sessions" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdateSessionRequest" }, "examples": { "update_session": { "summary": "Update a proxy session", "value": { "sessionId": "AY+MIjMzfu6P/05OTk5OTg==", "host": "203.0.113.99", "port": 8080, "username": "user-rotated" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/proxies.v1.UpdateSessionResponse" }, "examples": { "update_session": { "summary": "Update a proxy session", "value": { "session": { "id": "AY+MIjMzfu6P/05OTk5OTg==", "workspaceId": "AY+MHnorfD2eTxorPE1ebw==", "poolId": "AY+MISIifMyN3T09PT09PQ==", "providerId": "AY+MIBEReqqLuywsLCwsLA==", "token": "sess-abc123", "scheme": "http", "host": "203.0.113.99", "port": 8080, "username": "user-rotated", "enabled": true, "version": "3", "createdAt": "2026-06-20T12:00:00Z", "updatedAt": "2026-06-29T11:00:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/AcceptConfirmation": { "post": { "operationId": "steam.v1.Steam.AcceptConfirmation", "summary": "Accept a mobile confirmation", "description": "Approve a pending Steam mobile confirmation for the account, releasing the trade or listing it guards. The confirmation must still be pending.", "tags": [ "Confirmations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.AcceptConfirmationRequest" }, "examples": { "accept_confirmation": { "summary": "Accept a mobile confirmation", "value": { "accountName": "trader_bot_01", "confirmationId": "14258039472" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.AcceptConfirmationResponse" }, "examples": { "accept_confirmation": { "summary": "Accept a mobile confirmation", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/AcceptTradeOffer": { "post": { "operationId": "steam.v1.Steam.AcceptTradeOffer", "summary": "Accept a trade offer", "description": "Accept an incoming trade offer received by the account. The offer must still be active to be accepted.", "tags": [ "Trade Offers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.AcceptTradeOfferRequest" }, "examples": { "accept_trade_offer": { "summary": "Accept a trade offer", "value": { "accountName": "trader_bot_01", "offerId": "6483920184" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.AcceptTradeOfferResponse" }, "examples": { "accept_trade_offer": { "summary": "Accept a trade offer", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/BulkCreateAccounts": { "post": { "operationId": "steam.v1.Steam.BulkCreateAccounts", "summary": "Create multiple Steam accounts at once", "description": "Import a batch of Steam accounts in a single call. Each account succeeds or fails independently, and the response reports the outcome for every submitted row.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.BulkCreateAccountsRequest" }, "examples": { "bulk_create_accounts": { "summary": "Create multiple Steam accounts at once", "value": { "accounts": [ { "accountName": "trader_bot_01", "password": "hunter2pass", "sharedSecret": "sharedSecretBase64Value==", "identitySecret": "identitySecretBase64Value==" }, { "accountName": "trader_bot_02", "password": "hunter3pass", "sharedSecret": "anotherSharedSecret==", "identitySecret": "anotherIdentitySecret==" } ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.BulkCreateAccountsResponse" }, "examples": { "bulk_create_accounts": { "summary": "Create multiple Steam accounts at once", "value": { "results": [ { "account": { "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "sessionStatus": "SESSION_STATUS_DISCONNECTED", "communityBanned": false, "locked": false, "vacBanned": false, "numberOfGameBans": 0, "economyBan": "none" } }, { "error": { "code": "BULK_CREATE_ACCOUNT_ERROR_CODE_ALREADY_EXISTS", "message": "account already exists" } } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/CancelTradeOffer": { "post": { "operationId": "steam.v1.Steam.CancelTradeOffer", "summary": "Cancel a sent trade offer", "description": "Cancel an outgoing trade offer the account previously sent. The offer must still be active.", "tags": [ "Trade Offers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.CancelTradeOfferRequest" }, "examples": { "cancel_trade_offer": { "summary": "Cancel a sent trade offer", "value": { "accountName": "trader_bot_01", "offerId": "6483920184" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.CancelTradeOfferResponse" }, "examples": { "cancel_trade_offer": { "summary": "Cancel a sent trade offer", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/CreateAccount": { "post": { "operationId": "steam.v1.Steam.CreateAccount", "summary": "Create a Steam account", "description": "Store a new Steam account's credentials in the workspace so the platform can manage its session, trades, and inventory. The account name must be unique within the workspace.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.CreateAccountRequest" }, "examples": { "create_account": { "summary": "Create a Steam account", "value": { "accountName": "trader_bot_01", "password": "hunter2pass", "sharedSecret": "sharedSecretBase64Value==", "identitySecret": "identitySecretBase64Value==" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.CreateAccountResponse" }, "examples": { "create_account": { "summary": "Create a Steam account", "value": { "account": { "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "sessionStatus": "SESSION_STATUS_DISCONNECTED", "communityBanned": false, "locked": false, "vacBanned": false, "numberOfGameBans": 0, "economyBan": "none" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "409": { "description": "The resource already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "already_exists": { "value": { "code": "already_exists", "message": "The resource already exists." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/DeclineConfirmation": { "post": { "operationId": "steam.v1.Steam.DeclineConfirmation", "summary": "Decline a mobile confirmation", "description": "Reject a pending Steam mobile confirmation for the account, cancelling the trade or listing it guards. The confirmation must still be pending.", "tags": [ "Confirmations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.DeclineConfirmationRequest" }, "examples": { "decline_confirmation": { "summary": "Decline a mobile confirmation", "value": { "accountName": "trader_bot_01", "confirmationId": "14258039472" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.DeclineConfirmationResponse" }, "examples": { "decline_confirmation": { "summary": "Decline a mobile confirmation", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/DeclineTradeOffer": { "post": { "operationId": "steam.v1.Steam.DeclineTradeOffer", "summary": "Decline a trade offer", "description": "Decline an incoming trade offer received by the account. The offer must still be active.", "tags": [ "Trade Offers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.DeclineTradeOfferRequest" }, "examples": { "decline_trade_offer": { "summary": "Decline a trade offer", "value": { "accountName": "trader_bot_01", "offerId": "6483920184" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.DeclineTradeOfferResponse" }, "examples": { "decline_trade_offer": { "summary": "Decline a trade offer", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/DeleteAccount": { "post": { "operationId": "steam.v1.Steam.DeleteAccount", "summary": "Delete a Steam account", "description": "Remove a Steam account from the workspace. Its session is torn down and it stops being managed by the platform.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.DeleteAccountRequest" }, "examples": { "delete_account": { "summary": "Delete a Steam account", "value": { "accountName": "trader_bot_01" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.DeleteAccountResponse" }, "examples": { "delete_account": { "summary": "Delete a Steam account", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/GetAccount": { "post": { "operationId": "steam.v1.Steam.GetAccount", "summary": "Get a Steam account", "description": "Retrieve a single Steam account by its account name, including its live session status and account health flags.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetAccountRequest" }, "examples": { "get_account": { "summary": "Get a Steam account", "value": { "accountName": "trader_bot_01" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetAccountResponse" }, "examples": { "get_account": { "summary": "Get a Steam account", "value": { "account": { "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "sessionStatus": "SESSION_STATUS_LOGGED_ON", "steamId": "76561198000000001", "sessionConnectedAt": "2026-06-29T11:45:00Z", "communityBanned": false, "locked": false, "vacBanned": false, "numberOfGameBans": 0, "economyBan": "none" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/GetAccounts": { "post": { "operationId": "steam.v1.Steam.GetAccounts", "summary": "Get multiple Steam accounts by name", "description": "Look up several Steam accounts in one call. Returns the accounts that exist and lists any requested names that were not found.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetAccountsRequest" }, "examples": { "get_accounts": { "summary": "Get multiple Steam accounts by name", "value": { "accountNames": [ "trader_bot_01", "trader_bot_02" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetAccountsResponse" }, "examples": { "get_accounts": { "summary": "Get multiple Steam accounts by name", "value": { "accounts": [ { "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "sessionStatus": "SESSION_STATUS_LOGGED_ON", "steamId": "76561198000000001", "sessionConnectedAt": "2026-06-29T11:45:00Z", "communityBanned": false, "locked": false, "vacBanned": false, "numberOfGameBans": 0, "economyBan": "none" } ], "notFoundAccountNames": [ "trader_bot_02" ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/GetFriendsList": { "post": { "operationId": "steam.v1.Steam.GetFriendsList", "summary": "Get an account's Steam friends", "description": "Return the most recently cached snapshot of a Steam account's friends list, including each friend's relationship status. The data reflects the live session cache and is returned without contacting Steam.", "tags": [ "Friends" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetFriendsListRequest" }, "examples": { "get_friends_list": { "summary": "Get an account's Steam friends", "value": { "accountName": "trader_bot_01" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetFriendsListResponse" }, "examples": { "get_friends_list": { "summary": "Get an account's Steam friends", "value": { "friendsList": { "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "friends": [ { "steamId": "76561198044443322", "relationship": 3 } ], "observedAt": "2026-06-29T11:55:00Z" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/GetInventory": { "post": { "operationId": "steam.v1.Steam.GetInventory", "summary": "Get a Steam account's inventory", "description": "Return a paginated page of the most recently observed inventory snapshot for a Steam account, including each item's tradability and a timestamp showing how fresh the snapshot is. Use the returned cursor to fetch subsequent pages.", "tags": [ "Inventory" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetInventoryRequest" }, "examples": { "get_inventory": { "summary": "Get a Steam account's inventory", "value": { "accountName": "trader_bot_01", "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetInventoryResponse" }, "examples": { "get_inventory": { "summary": "Get a Steam account's inventory", "value": { "items": [ { "assetId": "31795888228", "classId": "310776898", "instanceId": "302028390", "marketHashName": "AK-47 | Redline (Field-Tested)", "appId": 730, "contextId": "2", "amount": "1", "tradable": true } ], "fetchedAt": "2026-06-29T11:50:00Z", "nextCursor": "31795888228" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/GetPersonaStates": { "post": { "operationId": "steam.v1.Steam.GetPersonaStates", "summary": "Get cached persona states", "description": "Return the cached persona snapshots (display name, online state, and current game) for the requested Steam users. Only users already observed by the account's session are returned.", "tags": [ "Friends" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetPersonaStatesRequest" }, "examples": { "get_persona_states": { "summary": "Get cached persona states", "value": { "accountName": "trader_bot_01", "steamIds": [ "76561198044443322", "76561198055554433" ] } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetPersonaStatesResponse" }, "examples": { "get_persona_states": { "summary": "Get cached persona states", "value": { "personas": [ { "steamId": "76561198044443322", "playerName": "BuyerOne", "state": 1, "gameId": "730", "gameName": "Counter-Strike 2", "observedAt": "2026-06-29T11:56:00Z" } ] } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/GetWorkspaceAPIKey": { "post": { "operationId": "steam.v1.Steam.GetWorkspaceAPIKey", "summary": "Get the workspace's Steam Web API key status", "description": "Report whether the workspace has configured its workspace-tier Steam Web API key, and when and by whom it was last set. Never returns the key itself.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetWorkspaceAPIKeyRequest" }, "examples": { "get_workspace_api_key": { "summary": "Get the workspace's Steam Web API key status", "value": {} } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.GetWorkspaceAPIKeyResponse" }, "examples": { "get_workspace_api_key": { "summary": "Get the workspace's Steam Web API key status", "value": { "configured": true, "updatedAt": "2026-06-29T11:45:00Z", "updatedBy": "AY86PB0ufwCKGyw9Tl9gcQ==" } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/ListAccounts": { "post": { "operationId": "steam.v1.Steam.ListAccounts", "summary": "List Steam accounts", "description": "Return a paginated list of the Steam accounts in the workspace. Each page carries the full hydrated accounts, so a caller renders it directly without a follow-up lookup. Use the returned cursor to fetch subsequent pages.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListAccountsRequest" }, "examples": { "list_accounts": { "summary": "List Steam accounts", "value": { "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListAccountsResponse" }, "examples": { "list_accounts": { "summary": "List Steam accounts", "value": { "accounts": [ { "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "sessionStatus": "SESSION_STATUS_LOGGED_ON", "steamId": "76561198000000001", "sessionConnectedAt": "2026-06-29T11:45:00Z", "communityBanned": false, "locked": false, "vacBanned": false, "numberOfGameBans": 0, "economyBan": "none" } ], "nextCursor": "eyJhIjoidHJhZGVyX2JvdF8wMiJ9" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/ListChatConversations": { "post": { "operationId": "steam.v1.Steam.ListChatConversations", "summary": "List chat conversations", "description": "Return an account's chat conversations ordered by most recent activity, each with a message preview and unread count for rendering a conversation sidebar.", "tags": [ "Chat" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListChatConversationsRequest" }, "examples": { "list_chat_conversations": { "summary": "List chat conversations", "value": { "accountName": "trader_bot_01", "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListChatConversationsResponse" }, "examples": { "list_chat_conversations": { "summary": "List chat conversations", "value": { "conversations": [ { "partnerSteamId": "76561198044443322", "lastMessageAt": "2026-06-29T11:52:00Z", "lastMessagePreview": "Hi, your item has been sent!", "unreadCount": 2 } ], "nextCursor": "eyJ0cyI6IjIwMjYtMDYtMjkifQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/ListChatMessages": { "post": { "operationId": "steam.v1.Steam.ListChatMessages", "summary": "List chat messages in a conversation", "description": "Return a paginated, newest-first slice of the chat messages exchanged between the account and a specific Steam user.", "tags": [ "Chat" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListChatMessagesRequest" }, "examples": { "list_chat_messages": { "summary": "List chat messages in a conversation", "value": { "accountName": "trader_bot_01", "partnerSteamId": "76561198044443322", "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListChatMessagesResponse" }, "examples": { "list_chat_messages": { "summary": "List chat messages in a conversation", "value": { "messages": [ { "id": "81923", "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "partnerSteamId": "76561198044443322", "direction": "CHAT_MESSAGE_DIRECTION_OUTBOUND", "body": "Hi, your item has been sent!", "sentAt": "2026-06-29T11:52:00Z", "createdAt": "2026-06-29T11:52:01Z" } ], "nextCursor": "eyJpZCI6ODE5MjN9" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/ListConfirmations": { "post": { "operationId": "steam.v1.Steam.ListConfirmations", "summary": "List mobile confirmations", "description": "Return a paginated list of an account's Steam mobile confirmations, optionally filtered by status. Each entry links to the trade offer or market listing it confirms.", "tags": [ "Confirmations" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListConfirmationsRequest" }, "examples": { "list_confirmations": { "summary": "List mobile confirmations", "value": { "accountName": "trader_bot_01", "status": "CONFIRMATION_STATUS_PENDING", "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListConfirmationsResponse" }, "examples": { "list_confirmations": { "summary": "List mobile confirmations", "value": { "confirmations": [ { "confirmationId": "14258039472", "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "type": "trade", "creatorId": "6483920185", "status": "CONFIRMATION_STATUS_PENDING", "createdAt": "2026-06-29T11:31:00Z" } ], "nextCursor": "eyJpZCI6IjE0MjU4MDM5NDcyIn0=" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/ListTradeOffers": { "post": { "operationId": "steam.v1.Steam.ListTradeOffers", "summary": "List trade offers", "description": "Return a paginated list of trade offers for the workspace, newest first. You can filter to a single account or to a specific offer state.", "tags": [ "Trade Offers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListTradeOffersRequest" }, "examples": { "list_trade_offers": { "summary": "List trade offers", "value": { "accountName": "trader_bot_01", "state": "active", "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListTradeOffersResponse" }, "examples": { "list_trade_offers": { "summary": "List trade offers", "value": { "tradeOffers": [ { "offerId": "6483920184", "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "partnerSteamId": "76561198044443322", "state": "active", "itemsToGive": [ { "assetId": "31795888228", "classId": "310776898", "instanceId": "302028390", "marketHashName": "AK-47 | Redline (Field-Tested)", "appId": 730, "contextId": "2", "amount": "1" } ], "createdAt": "2026-06-29T11:30:00Z", "expiresAt": "2026-07-13T11:30:00Z", "updatedAt": "2026-06-29T11:30:00Z", "message": "Thanks for the trade" } ], "nextCursor": "eyJvZmZlcklkIjoiNjQ4MzkyMDE4NCJ9" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/ListWorkspaceConversations": { "post": { "operationId": "steam.v1.Steam.ListWorkspaceConversations", "summary": "List chat conversations across the workspace", "description": "Return one aggregated conversation per counterpart across every Steam account in the workspace, ordered by most recent activity, so a person the operator talks to on several accounts appears once with a combined unread count and the set of accounts holding a thread with them.", "tags": [ "Chat" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListWorkspaceConversationsRequest" }, "examples": { "list_workspace_conversations": { "summary": "List chat conversations across the workspace", "value": { "limit": 50 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.ListWorkspaceConversationsResponse" }, "examples": { "list_workspace_conversations": { "summary": "List chat conversations across the workspace", "value": { "conversations": [ { "partnerSteamId": "76561198044443322", "lastMessageAt": "2026-06-29T11:52:00Z", "lastMessagePreview": "Hi, your item has been sent!", "unreadCount": 3, "accounts": [ { "accountName": "trader_bot_01", "lastMessageAt": "2026-06-29T11:52:00Z", "unreadCount": 2 }, { "accountName": "trader_bot_02", "lastMessageAt": "2026-06-29T09:14:00Z", "unreadCount": 1 } ] } ], "nextCursor": "eyJ0cyI6IjIwMjYtMDYtMjkifQ==" } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/MarkChatRead": { "post": { "operationId": "steam.v1.Steam.MarkChatRead", "summary": "Mark a conversation as read", "description": "Move the read marker for a conversation up to a given timestamp so unread counts reflect what the user has already seen.", "tags": [ "Chat" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.MarkChatReadRequest" }, "examples": { "mark_chat_read": { "summary": "Mark a conversation as read", "value": { "accountName": "trader_bot_01", "partnerSteamId": "76561198044443322", "lastReadAt": "2026-06-29T11:53:00Z" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.MarkChatReadResponse" }, "examples": { "mark_chat_read": { "summary": "Mark a conversation as read", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/SendChatMessage": { "post": { "operationId": "steam.v1.Steam.SendChatMessage", "summary": "Send a chat message", "description": "Send a friend chat message from the account to a Steam user. Messages have a maximum length and are subject to a daily send cap per account.", "tags": [ "Chat" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.SendChatMessageRequest" }, "examples": { "send_chat_message": { "summary": "Send a chat message", "value": { "accountName": "trader_bot_01", "partnerSteamId": "76561198044443322", "body": "Hi, your item has been sent!" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.SendChatMessageResponse" }, "examples": { "send_chat_message": { "summary": "Send a chat message", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/SendTradeOffer": { "post": { "operationId": "steam.v1.Steam.SendTradeOffer", "summary": "Send a trade offer", "description": "Create and send a new trade offer from the account to a partner using the partner's trade URL token. A success response means the send was routed to the account's session, not that Steam has created the offer: the created offer id and whether a mobile confirmation is pending surface asynchronously via the trade-offer feed, or ListTradeOffers for reconciliation.", "tags": [ "Trade Offers" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.SendTradeOfferRequest" }, "examples": { "send_trade_offer": { "summary": "Send a trade offer", "value": { "accountName": "trader_bot_01", "partnerSteamId": "76561198044443322", "tradeToken": "aBcD1234", "itemsToGive": [ { "assetId": "31795888228", "classId": "310776898", "instanceId": "302028390", "marketHashName": "AK-47 | Redline (Field-Tested)", "appId": 730, "contextId": "2", "amount": "1" } ], "message": "Delivery for your purchase" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.SendTradeOfferResponse" }, "examples": { "send_trade_offer": { "summary": "Send a trade offer", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "failed_precondition": { "value": { "code": "failed_precondition", "message": "The request cannot be carried out in the current system state." } }, "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/SetWorkspaceAPIKey": { "post": { "operationId": "steam.v1.Steam.SetWorkspaceAPIKey", "summary": "Set the workspace's Steam Web API key", "description": "Upsert the workspace-tier Steam Web API key shared by every account in the workspace, the second tier of the key resolution hierarchy. Write-only: the key is never returned by any RPC.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.SetWorkspaceAPIKeyRequest" }, "examples": { "set_workspace_api_key": { "summary": "Set the workspace's Steam Web API key", "value": { "apiKey": "1A2B3C4D5E6F7890ABCDEF1234567890" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.SetWorkspaceAPIKeyResponse" }, "examples": { "set_workspace_api_key": { "summary": "Set the workspace's Steam Web API key", "value": {} } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } }, "/steam.v1.Steam/UpdateAccount": { "post": { "operationId": "steam.v1.Steam.UpdateAccount", "summary": "Update a Steam account's credentials", "description": "Change the stored password, shared secret, identity secret, or account-tier Steam Web API key for an existing Steam account. Only the fields you supply are updated.", "tags": [ "Accounts" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.UpdateAccountRequest" }, "examples": { "update_account": { "summary": "Update a Steam account's credentials", "value": { "accountName": "trader_bot_01", "password": "newpassword99" } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/steam.v1.UpdateAccountResponse" }, "examples": { "update_account": { "summary": "Update a Steam account's credentials", "value": { "account": { "accountName": "trader_bot_01", "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ==", "sessionStatus": "SESSION_STATUS_LOGGED_ON", "steamId": "76561198000000001", "sessionConnectedAt": "2026-06-29T11:45:00Z", "communityBanned": false, "locked": false, "vacBanned": false, "numberOfGameBans": 0, "economyBan": "none" } } } } } } }, "400": { "description": "The request was malformed, such as a missing required field or an unparseable cursor.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "invalid_argument": { "value": { "code": "invalid_argument", "message": "The request was malformed, such as a missing required field or an unparseable cursor." } } } } } }, "401": { "description": "The request lacks a valid API key in the Authorization header.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "unauthenticated": { "value": { "code": "unauthenticated", "message": "The request lacks a valid API key in the Authorization header." } } } } } }, "403": { "description": "The API key is not allowed to perform this action on this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "permission_denied": { "value": { "code": "permission_denied", "message": "The API key is not allowed to perform this action on this workspace." } } } } } }, "404": { "description": "The requested resource does not exist in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "not_found": { "value": { "code": "not_found", "message": "The requested resource does not exist in this workspace." } } } } } }, "429": { "description": "The request was rate limited. Slow down and retry later.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "resource_exhausted": { "value": { "code": "resource_exhausted", "message": "The request was rate limited. Slow down and retry later." } } } } } }, "500": { "description": "An internal server error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectError" }, "examples": { "internal": { "value": { "code": "internal", "message": "An internal server error occurred." } } } } } } } } } }, "components": { "schemas": { "ConnectError": { "type": "object", "description": "Connect RPC error envelope. See https://connectrpc.com/docs/protocol for the wire format.", "properties": { "code": { "type": "string", "description": "The Connect error code, such as \"not_found\".", "example": "not_found" }, "details": { "type": "array", "description": "Optional machine-readable error details.", "items": { "type": "object" } }, "message": { "type": "string", "description": "A human-readable description of the error." } }, "required": [ "code", "message" ] }, "accounts.v1.APIKey": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "byte" }, "keyPrefix": { "type": "string" }, "lastUsedAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "policies": { "type": "array", "items": { "type": "string" } }, "workspaceId": { "type": "string", "format": "byte" } } }, "accounts.v1.AcceptMembershipRequest": { "type": "object", "properties": { "membershipId": { "type": "string", "format": "byte" } } }, "accounts.v1.AcceptMembershipResponse": { "type": "object", "properties": { "membership": { "$ref": "#/components/schemas/accounts.v1.Membership" } } }, "accounts.v1.AddEmailCredentialRequest": { "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "turnstileToken": { "type": "string" } } }, "accounts.v1.AddEmailCredentialResponse": { "type": "object" }, "accounts.v1.AuthenticationIdentity": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "byte" }, "provider": { "type": "string", "enum": [ "AUTHENTICATION_PROVIDER_UNSPECIFIED", "AUTHENTICATION_PROVIDER_DISCORD" ] }, "providerId": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "byte" } } }, "accounts.v1.BeginPasskeyRegistrationRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "accounts.v1.BeginPasskeyRegistrationResponse": { "type": "object", "properties": { "options": { "type": "string", "format": "byte" } } }, "accounts.v1.BeginStepUpRequest": { "type": "object" }, "accounts.v1.BeginStepUpResponse": { "type": "object", "properties": { "allowedMethods": { "type": "array", "items": { "type": "string", "enum": [ "TWO_FACTOR_METHOD_UNSPECIFIED", "TWO_FACTOR_METHOD_EMAIL", "TWO_FACTOR_METHOD_TOTP", "TWO_FACTOR_METHOD_PASSKEY" ] } }, "challengeId": { "type": "string" } } }, "accounts.v1.ChangeEmailRequest": { "type": "object", "properties": { "newEmail": { "type": "string" }, "password": { "type": "string" } } }, "accounts.v1.ChangeEmailResponse": { "type": "object" }, "accounts.v1.ChangePasswordRequest": { "type": "object", "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "accounts.v1.ChangePasswordResponse": { "type": "object" }, "accounts.v1.CountAPIKeysRequest": { "type": "object" }, "accounts.v1.CountAPIKeysResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "accounts.v1.CountMembershipsRequest": { "type": "object", "properties": { "userId": { "type": "string", "format": "byte", "description": "Optional filter: count only memberships for this user." }, "workspaceId": { "type": "string", "format": "byte", "description": "Optional filter: count only memberships in this workspace." } } }, "accounts.v1.CountMembershipsResponse": { "type": "object", "properties": { "counts": { "type": "array", "description": "Count of memberships in each status, scoped to the requested filters. A status with no memberships may be omitted.", "items": { "$ref": "#/components/schemas/accounts.v1.MembershipStatusCount" } } } }, "accounts.v1.CreateAPIKeyRequest": { "type": "object", "properties": { "expiresAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" }, "policies": { "type": "array", "items": { "type": "string" } } } }, "accounts.v1.CreateAPIKeyResponse": { "type": "object", "properties": { "apiKey": { "$ref": "#/components/schemas/accounts.v1.APIKey" }, "rawKey": { "type": "string" } } }, "accounts.v1.CreateMembershipRequest": { "type": "object", "properties": { "policies": { "type": "array", "items": { "type": "string" } }, "userId": { "type": "string", "format": "byte" } } }, "accounts.v1.CreateMembershipResponse": { "type": "object", "properties": { "membership": { "$ref": "#/components/schemas/accounts.v1.Membership" } } }, "accounts.v1.CreateUserRequest": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" } } }, "accounts.v1.CreateUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/accounts.v1.User" } } }, "accounts.v1.CreateWorkspaceRequest": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" } } }, "accounts.v1.CreateWorkspaceResponse": { "type": "object", "properties": { "workspace": { "$ref": "#/components/schemas/accounts.v1.Workspace" } } }, "accounts.v1.DeclineMembershipRequest": { "type": "object", "properties": { "membershipId": { "type": "string", "format": "byte" } } }, "accounts.v1.DeclineMembershipResponse": { "type": "object" }, "accounts.v1.DeleteAPIKeyRequest": { "type": "object", "properties": { "apiKeyId": { "type": "string", "format": "byte" } } }, "accounts.v1.DeleteAPIKeyResponse": { "type": "object" }, "accounts.v1.DeleteMembershipRequest": { "type": "object", "properties": { "membershipId": { "type": "string", "format": "byte" } } }, "accounts.v1.DeleteMembershipResponse": { "type": "object" }, "accounts.v1.DeletePasskeyRequest": { "type": "object", "properties": { "passkeyId": { "type": "string", "format": "byte" }, "password": { "type": "string" }, "totpCode": { "type": "string" } } }, "accounts.v1.DeletePasskeyResponse": { "type": "object" }, "accounts.v1.DeleteWorkspaceRequest": { "type": "object" }, "accounts.v1.DeleteWorkspaceResponse": { "type": "object" }, "accounts.v1.DisableTOTPRequest": { "type": "object", "properties": { "password": { "type": "string" }, "totpCode": { "type": "string" } } }, "accounts.v1.DisableTOTPResponse": { "type": "object" }, "accounts.v1.FinishPasskeyRegistrationRequest": { "type": "object", "properties": { "attestation": { "type": "string", "format": "byte" } } }, "accounts.v1.FinishPasskeyRegistrationResponse": { "type": "object", "properties": { "passkey": { "$ref": "#/components/schemas/accounts.v1.Passkey" } } }, "accounts.v1.GetMembershipRequest": { "type": "object", "properties": { "membershipId": { "type": "string", "format": "byte" } } }, "accounts.v1.GetMembershipResponse": { "type": "object", "properties": { "membership": { "$ref": "#/components/schemas/accounts.v1.Membership" } } }, "accounts.v1.GetMembershipsRequest": { "type": "object", "properties": { "membershipIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "accounts.v1.GetMembershipsResponse": { "type": "object", "properties": { "memberships": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.Membership" } }, "notFoundIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "accounts.v1.GetMyPermissionsRequest": { "type": "object" }, "accounts.v1.GetMyPermissionsResponse": { "type": "object", "properties": { "isAdministrator": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "PERMISSION_UNSPECIFIED", "PERMISSION_PUBLIC", "PERMISSION_AUTHENTICATED", "PERMISSION_INTERNAL", "PERMISSION_ADMINISTRATOR", "PERMISSION_VIEW_WORKSPACE_SETTINGS", "PERMISSION_MANAGE_WORKSPACE_SETTINGS", "PERMISSION_VIEW_MEMBERSHIPS", "PERMISSION_MANAGE_MEMBERSHIPS", "PERMISSION_VIEW_API_KEYS", "PERMISSION_MANAGE_API_KEYS", "PERMISSION_VIEW_AUDIT", "PERMISSION_VIEW_CONTRACTS", "PERMISSION_MANAGE_CONTRACTS", "PERMISSION_VIEW_PURCHASES", "PERMISSION_MANAGE_PURCHASES", "PERMISSION_VIEW_INVENTORY", "PERMISSION_MANAGE_INVENTORY", "PERMISSION_VIEW_STEAM_ACCOUNTS", "PERMISSION_MANAGE_STEAM_ACCOUNTS", "PERMISSION_VIEW_TRADE_OFFERS", "PERMISSION_MANAGE_TRADE_OFFERS", "PERMISSION_VIEW_CHAT_MESSAGES", "PERMISSION_MANAGE_CHAT_MESSAGES", "PERMISSION_VIEW_PROXY_PROVIDERS", "PERMISSION_MANAGE_PROXY_PROVIDERS", "PERMISSION_VIEW_PROXY_POOLS", "PERMISSION_MANAGE_PROXY_POOLS", "PERMISSION_VIEW_PROXY_SESSIONS", "PERMISSION_MANAGE_PROXY_SESSIONS", "PERMISSION_VIEW_PROXY_ASSIGNMENTS", "PERMISSION_MANAGE_PROXY_ASSIGNMENTS", "PERMISSION_VIEW_ANALYTICS", "PERMISSION_VIEW_CSFLOAT_ACCOUNTS" ] } }, "policies": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string" } } }, "accounts.v1.GetTwoFactorStatusRequest": { "type": "object" }, "accounts.v1.GetTwoFactorStatusResponse": { "type": "object", "properties": { "activeMethod": { "type": "string", "enum": [ "TWO_FACTOR_METHOD_UNSPECIFIED", "TWO_FACTOR_METHOD_EMAIL", "TWO_FACTOR_METHOD_TOTP", "TWO_FACTOR_METHOD_PASSKEY" ] }, "backupCodesRemaining": { "type": "integer", "format": "int32" }, "emailAvailable": { "type": "boolean" }, "passkeyEnrolled": { "type": "boolean" }, "totpEnrolled": { "type": "boolean" } } }, "accounts.v1.GetUserByEmailRequest": { "type": "object", "properties": { "email": { "type": "string" } } }, "accounts.v1.GetUserByEmailResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/accounts.v1.User" } } }, "accounts.v1.GetUserRequest": { "type": "object", "properties": { "userId": { "type": "string", "format": "byte" } } }, "accounts.v1.GetUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/accounts.v1.User" } } }, "accounts.v1.GetUsersRequest": { "type": "object", "properties": { "userIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "accounts.v1.GetUsersResponse": { "type": "object", "properties": { "notFoundIds": { "type": "array", "items": { "type": "string", "format": "byte" } }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.User" } } } }, "accounts.v1.GetWorkspaceRequest": { "type": "object" }, "accounts.v1.GetWorkspaceResponse": { "type": "object", "properties": { "workspace": { "description": "The requested workspace.", "$ref": "#/components/schemas/accounts.v1.Workspace" } } }, "accounts.v1.GetWorkspacesRequest": { "type": "object", "properties": { "workspaceIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "accounts.v1.GetWorkspacesResponse": { "type": "object", "properties": { "notFoundIds": { "type": "array", "items": { "type": "string", "format": "byte" } }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.Workspace" } } } }, "accounts.v1.LinkDiscordRequest": { "type": "object" }, "accounts.v1.LinkDiscordResponse": { "type": "object", "properties": { "authorizeUrl": { "type": "string" } } }, "accounts.v1.ListAPIKeysRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" } } }, "accounts.v1.ListAPIKeysResponse": { "type": "object", "properties": { "apiKeys": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.APIKey" } }, "nextCursor": { "type": "string" } } }, "accounts.v1.ListAuthenticationIdentitiesRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "userId": { "type": "string", "format": "byte" } } }, "accounts.v1.ListAuthenticationIdentitiesResponse": { "type": "object", "properties": { "authenticationIdentities": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.AuthenticationIdentity" } }, "nextCursor": { "type": "string" } } }, "accounts.v1.ListMembershipsRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "userId": { "type": "string", "format": "byte" }, "workspaceId": { "type": "string", "format": "byte" } } }, "accounts.v1.ListMembershipsResponse": { "type": "object", "properties": { "memberships": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.Membership" } }, "nextCursor": { "type": "string" } } }, "accounts.v1.ListPasskeysRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" } } }, "accounts.v1.ListPasskeysResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "passkeys": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.Passkey" } } } }, "accounts.v1.ListPoliciesRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" } } }, "accounts.v1.ListPoliciesResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "policies": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.Policy" } } } }, "accounts.v1.ListSessionsRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" } } }, "accounts.v1.ListSessionsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.SessionDetail" } } } }, "accounts.v1.ListWorkspacesRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListWorkspacesResponse's next_cursor. The client must not parse or construct one. Empty for the first page; an empty next_cursor on the response signals the last page." }, "descending": { "type": "boolean", "description": "Order descending instead of ascending." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of workspaces to return. Server caps this at a service-defined upper bound." }, "query": { "type": "string", "description": "Optional case-insensitive substring filter on name, matched server side. Empty returns every row." }, "sortField": { "type": "string", "description": "Field to order the page by. Unspecified orders by creation time.", "enum": [ "WORKSPACE_SORT_FIELD_UNSPECIFIED", "WORKSPACE_SORT_FIELD_CREATED_AT", "WORKSPACE_SORT_FIELD_NAME" ] } } }, "accounts.v1.ListWorkspacesResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "workspaces": { "type": "array", "items": { "$ref": "#/components/schemas/accounts.v1.Workspace" } } } }, "accounts.v1.Membership": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "byte" }, "policies": { "type": "array", "items": { "type": "string" } }, "role": { "type": "string", "enum": [ "MEMBERSHIP_ROLE_UNSPECIFIED", "MEMBERSHIP_ROLE_OWNER", "MEMBERSHIP_ROLE_MEMBER" ] }, "status": { "type": "string", "enum": [ "MEMBERSHIP_STATUS_UNSPECIFIED", "MEMBERSHIP_STATUS_INVITED", "MEMBERSHIP_STATUS_ACCEPTED" ] }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "string", "format": "byte" }, "workspaceId": { "type": "string", "format": "byte" } } }, "accounts.v1.MembershipStatusCount": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Number of memberships in this status." }, "status": { "type": "string", "description": "The membership status this count is for.", "enum": [ "MEMBERSHIP_STATUS_UNSPECIFIED", "MEMBERSHIP_STATUS_INVITED", "MEMBERSHIP_STATUS_ACCEPTED" ] } } }, "accounts.v1.Passkey": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "byte" }, "lastUsedAt": { "type": "string", "format": "date-time" }, "name": { "type": "string" } } }, "accounts.v1.Policy": { "type": "object", "properties": { "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string", "enum": [ "PERMISSION_UNSPECIFIED", "PERMISSION_PUBLIC", "PERMISSION_AUTHENTICATED", "PERMISSION_INTERNAL", "PERMISSION_ADMINISTRATOR", "PERMISSION_VIEW_WORKSPACE_SETTINGS", "PERMISSION_MANAGE_WORKSPACE_SETTINGS", "PERMISSION_VIEW_MEMBERSHIPS", "PERMISSION_MANAGE_MEMBERSHIPS", "PERMISSION_VIEW_API_KEYS", "PERMISSION_MANAGE_API_KEYS", "PERMISSION_VIEW_AUDIT", "PERMISSION_VIEW_CONTRACTS", "PERMISSION_MANAGE_CONTRACTS", "PERMISSION_VIEW_PURCHASES", "PERMISSION_MANAGE_PURCHASES", "PERMISSION_VIEW_INVENTORY", "PERMISSION_MANAGE_INVENTORY", "PERMISSION_VIEW_STEAM_ACCOUNTS", "PERMISSION_MANAGE_STEAM_ACCOUNTS", "PERMISSION_VIEW_TRADE_OFFERS", "PERMISSION_MANAGE_TRADE_OFFERS", "PERMISSION_VIEW_CHAT_MESSAGES", "PERMISSION_MANAGE_CHAT_MESSAGES", "PERMISSION_VIEW_PROXY_PROVIDERS", "PERMISSION_MANAGE_PROXY_PROVIDERS", "PERMISSION_VIEW_PROXY_POOLS", "PERMISSION_MANAGE_PROXY_POOLS", "PERMISSION_VIEW_PROXY_SESSIONS", "PERMISSION_MANAGE_PROXY_SESSIONS", "PERMISSION_VIEW_PROXY_ASSIGNMENTS", "PERMISSION_MANAGE_PROXY_ASSIGNMENTS", "PERMISSION_VIEW_ANALYTICS", "PERMISSION_VIEW_CSFLOAT_ACCOUNTS" ] } } } }, "accounts.v1.RegenerateBackupCodesRequest": { "type": "object", "properties": { "password": { "type": "string" }, "totpCode": { "type": "string" } } }, "accounts.v1.RegenerateBackupCodesResponse": { "type": "object", "properties": { "backupCodes": { "type": "array", "items": { "type": "string" } } } }, "accounts.v1.RotateWorkspaceKeyRequest": { "type": "object" }, "accounts.v1.RotateWorkspaceKeyResponse": { "type": "object", "properties": { "fromVersion": { "type": "integer", "format": "int32", "description": "Previously-current DEK version." }, "toVersion": { "type": "integer", "format": "int32", "description": "Newly-current DEK version." }, "workspaceId": { "type": "string", "format": "byte" } } }, "accounts.v1.SessionDetail": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "byte" }, "ipAddress": { "type": "string" }, "isCurrent": { "type": "boolean" }, "lastActiveAt": { "type": "string", "format": "date-time" }, "userAgent": { "type": "string" } } }, "accounts.v1.SetMembershipPoliciesRequest": { "type": "object", "properties": { "membershipId": { "type": "string", "format": "byte" }, "policies": { "type": "array", "items": { "type": "string" } } } }, "accounts.v1.SetMembershipPoliciesResponse": { "type": "object", "properties": { "membership": { "$ref": "#/components/schemas/accounts.v1.Membership" } } }, "accounts.v1.SetTwoFactorMethodRequest": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "TWO_FACTOR_METHOD_UNSPECIFIED", "TWO_FACTOR_METHOD_EMAIL", "TWO_FACTOR_METHOD_TOTP", "TWO_FACTOR_METHOD_PASSKEY" ] } } }, "accounts.v1.SetTwoFactorMethodResponse": { "type": "object" }, "accounts.v1.SetupTOTPRequest": { "type": "object" }, "accounts.v1.SetupTOTPResponse": { "type": "object", "properties": { "accountName": { "type": "string" }, "backupCodes": { "type": "array", "items": { "type": "string" } }, "issuer": { "type": "string" }, "qrCodeBase64": { "type": "string" }, "secret": { "type": "string" } } }, "accounts.v1.UpdateUserRequest": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "userId": { "type": "string", "format": "byte" } } }, "accounts.v1.UpdateUserResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/accounts.v1.User" } } }, "accounts.v1.UpdateWorkspaceRequest": { "type": "object", "properties": { "description": { "type": "string", "description": "New workspace description. Omit to leave unchanged." }, "name": { "type": "string", "description": "New workspace name. Omit to leave unchanged." } } }, "accounts.v1.UpdateWorkspaceResponse": { "type": "object", "properties": { "workspace": { "$ref": "#/components/schemas/accounts.v1.Workspace" } } }, "accounts.v1.User": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "id": { "type": "string", "format": "byte" }, "isAdministrator": { "type": "boolean" }, "name": { "type": "string" }, "status": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "accounts.v1.VerifyStepUpRequest": { "type": "object", "properties": { "backupCode": { "type": "string" }, "challengeId": { "type": "string" }, "emailCode": { "type": "string" }, "passkeyAssertion": { "type": "string", "format": "byte" }, "totpCode": { "type": "string" } } }, "accounts.v1.VerifyStepUpResponse": { "type": "object" }, "accounts.v1.VerifyTOTPSetupRequest": { "type": "object", "properties": { "code": { "type": "string" } } }, "accounts.v1.VerifyTOTPSetupResponse": { "type": "object" }, "accounts.v1.Workspace": { "type": "object", "description": "A workspace is the tenant boundary for all Goldmine data. Every contract, purchase, inventory item, and account belongs to exactly one workspace.", "properties": { "createdAt": { "type": "string", "format": "date-time", "description": "When the workspace was created." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the workspace was soft-deleted. Unset for active workspaces." }, "description": { "type": "string", "description": "Free-form workspace description set by the workspace owner." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte workspace identifier, base64-encoded in JSON.", "example": "AAECAwQFBgcICQoLDA0ODw==" }, "memberCount": { "type": "integer", "format": "int32", "description": "Number of accepted memberships in the workspace, computed server-side at read time. Read-only: any value sent by a client is ignored.", "example": 3 }, "name": { "type": "string", "description": "Human-readable workspace name.", "example": "Acme Trading" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the workspace was last modified." } } }, "analytics.v1.EvaluateContractIntent": { "type": "object", "properties": { "marketHashName": { "type": "string" }, "maxBuyPriceCents": { "type": "string", "format": "int64" }, "maxFloat": { "type": "number", "format": "double" }, "minFloat": { "type": "number", "format": "double" }, "referencePrices": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.ReferencePrice" } } } }, "analytics.v1.EvaluateContractRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte" }, "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "predicate": { "$ref": "#/components/schemas/contracts.v1.Predicate" }, "valuation": { "$ref": "#/components/schemas/contracts.v1.Valuation" } } }, "analytics.v1.EvaluateContractResponse": { "type": "object", "properties": { "intents": { "type": "array", "items": { "$ref": "#/components/schemas/analytics.v1.EvaluateContractIntent" } }, "nextCursor": { "type": "string" } } }, "analytics.v1.GetAvailableMetricsRequest": { "type": "object", "properties": { "marketHashName": { "type": "string" } } }, "analytics.v1.GetAvailableMetricsResponse": { "type": "object", "properties": { "sourceMetrics": { "type": "array", "items": { "$ref": "#/components/schemas/analytics.v1.SourceMetric" } } } }, "analytics.v1.GetContractCoverageRequest": { "type": "object", "properties": { "predicate": { "$ref": "#/components/schemas/contracts.v1.Predicate" }, "sampleLimit": { "type": "integer", "format": "int32" }, "valuation": { "$ref": "#/components/schemas/contracts.v1.Valuation" } } }, "analytics.v1.GetContractCoverageResponse": { "type": "object", "properties": { "matchedCount": { "type": "integer", "format": "int32" }, "pricedCount": { "type": "integer", "format": "int32" }, "unpricedCount": { "type": "integer", "format": "int32" }, "unpricedMarketHashNames": { "type": "array", "items": { "type": "string" } } } }, "analytics.v1.GetMarketObservationTimeSeriesRequest": { "type": "object", "properties": { "endTime": { "type": "string" }, "marketHashName": { "type": "string" }, "sourceMetrics": { "type": "array", "items": { "$ref": "#/components/schemas/analytics.v1.SourceMetric" } }, "startTime": { "type": "string" } } }, "analytics.v1.GetMarketObservationTimeSeriesResponse": { "type": "object", "properties": { "series": { "type": "array", "items": { "$ref": "#/components/schemas/analytics.v1.TimeSeries" } } } }, "analytics.v1.GetPricingRequest": { "type": "object", "properties": { "marketHashNames": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "string" } } } }, "analytics.v1.GetPricingResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/analytics.v1.PricingEntry" } } } }, "analytics.v1.InventoryItemChange": { "type": "object", "properties": { "action": { "type": "string" }, "amount": { "type": "string", "format": "int64" }, "appId": { "type": "integer", "format": "int32" }, "assetId": { "type": "string" }, "classId": { "type": "string" }, "contextId": { "type": "string" }, "instanceId": { "type": "string" }, "marketHashName": { "type": "string" }, "observedAt": { "type": "string" } } }, "analytics.v1.ListInventoryItemChangesRequest": { "type": "object", "properties": { "accountName": { "type": "string" }, "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" } } }, "analytics.v1.ListInventoryItemChangesResponse": { "type": "object", "properties": { "changes": { "type": "array", "items": { "$ref": "#/components/schemas/analytics.v1.InventoryItemChange" } }, "nextCursor": { "type": "string" } } }, "analytics.v1.PricingEntry": { "type": "object", "properties": { "avg30dCents": { "type": "string", "format": "int64" }, "avg7dCents": { "type": "string", "format": "int64" }, "bidCents": { "type": "string", "format": "int64" }, "liquidity": { "type": "number", "format": "double" }, "listingsCount": { "type": "integer", "format": "int32" }, "marketHashName": { "type": "string" }, "observedAt": { "type": "string" }, "priceCents": { "type": "string", "format": "int64" }, "source": { "type": "string" }, "supply": { "type": "number", "format": "double" }, "volume": { "type": "integer", "format": "int32" } } }, "analytics.v1.SourceMetric": { "type": "object", "properties": { "metric": { "type": "string" }, "source": { "type": "string" } } }, "analytics.v1.TimeSeries": { "type": "object", "properties": { "metric": { "type": "string" }, "points": { "type": "array", "items": { "$ref": "#/components/schemas/analytics.v1.TimeSeriesPoint" } }, "source": { "type": "string" } } }, "analytics.v1.TimeSeriesPoint": { "type": "object", "properties": { "timestamp": { "type": "string" }, "value": { "type": "number", "format": "double" } } }, "contracts.v1.AccountGroup": { "type": "object", "description": "A named, reusable set of Steam account names a contract executes against.", "properties": { "createdAt": { "type": "string", "format": "date-time", "description": "When the account group was created." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the account group was soft-deleted, if it has been." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte account group identifier, base64-encoded in JSON.", "example": "EBESExQVFhcYGRobHB0eHw==" }, "members": { "type": "array", "description": "Steam account names that belong to the group.", "items": { "type": "string" } }, "name": { "type": "string", "description": "Human-readable account group name." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the account group was last modified." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the account group belongs to." } } }, "contracts.v1.Aggregation": { "type": "object", "properties": { "average": { "$ref": "#/components/schemas/contracts.v1.AverageOptions" }, "type": { "type": "string", "enum": [ "AGGREGATION_TYPE_UNSPECIFIED", "AGGREGATION_TYPE_AVERAGE", "AGGREGATION_TYPE_MEDIAN", "AGGREGATION_TYPE_MINIMUM", "AGGREGATION_TYPE_MAXIMUM", "AGGREGATION_TYPE_MODE", "AGGREGATION_TYPE_PERCENTILE" ] } } }, "contracts.v1.AssetIDLink": { "type": "object", "description": "A single step in the Steam asset_id chain for an inventory item. Steam rotates asset_id on every trade; the chain preserves provenance across all rotations.", "properties": { "assetId": { "type": "string", "description": "Steam asset_id at this step.", "example": "29384710293" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the link was recorded." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the link was soft-deleted. Unset for active links." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte link identifier." }, "inventoryItemId": { "type": "string", "format": "byte", "description": "Inventory item this link belongs to." }, "previousAssetId": { "type": "string", "description": "Asset_id from the previous step. Empty for the first link in the chain." }, "purchaseId": { "type": "string", "format": "byte", "description": "Purchase the inventory item originated from." }, "source": { "type": "string", "description": "Source subsystem that produced the link.", "example": "listing" }, "sourceId": { "type": "string", "description": "External identifier from the source subsystem -- for example, a trade offer ID or marketplace listing ID.", "example": "csfloat-listing-8731" }, "step": { "type": "integer", "format": "int32", "description": "Zero-based append position in the chain: listing=0, purchase_trade=1, sale_trade=2. Higher values are later rotations; sale_trade is the terminal step.", "example": 0 }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace that owns the chain." } } }, "contracts.v1.AverageOptions": { "type": "object", "properties": { "weighted": { "type": "boolean" } } }, "contracts.v1.CSFloatAuctionStrategy": { "type": "object", "properties": { "bidBeforeExpirySeconds": { "type": "integer", "format": "int32" }, "maxConcurrentBids": { "type": "integer", "format": "int32" } } }, "contracts.v1.CSFloatBuyOrderStrategy": { "type": "object", "properties": { "maxOrders": { "type": "integer", "format": "int32" }, "maxPriceCents": { "type": "integer", "format": "int32" } } }, "contracts.v1.CSFloatOfferStrategy": { "type": "object", "properties": { "expiryHours": { "type": "integer", "format": "int32" }, "maxDiscountPct": { "type": "number", "format": "double" }, "minPriceCents": { "type": "string", "format": "int64" } } }, "contracts.v1.CSFloatScrapingStrategy": { "type": "object", "properties": { "maxConcurrent": { "type": "integer", "format": "int32" }, "scrapeIntervalMs": { "type": "string", "format": "int64" } } }, "contracts.v1.CSFloatSellStrategy": { "type": "object", "properties": { "priceSource": { "type": "string" }, "undercutPct": { "type": "number", "format": "double" } } }, "contracts.v1.Contract": { "type": "object", "description": "A contract is a declarative rule that specifies what items to buy or sell, at what valuation, using which marketplace strategies, subject to defined limits.", "properties": { "accountGroupId": { "type": "string", "format": "byte" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the contract was created." }, "deletedAt": { "type": "string", "format": "date-time" }, "description": { "type": "string", "description": "Free-form contract description." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte contract identifier, base64-encoded in JSON.", "example": "EBESExQVFhcYGRobHB0eHw==" }, "limits": { "$ref": "#/components/schemas/contracts.v1.ContractLimits" }, "name": { "type": "string", "description": "Human-readable contract name." }, "predicate": { "$ref": "#/components/schemas/contracts.v1.Predicate" }, "snapshot": { "type": "string", "format": "int64", "description": "Snapshot sequence number used to bind evaluation runs to a contract state." }, "status": { "type": "string", "description": "Contract lifecycle state.", "enum": [ "CONTRACT_STATUS_UNSPECIFIED", "CONTRACT_STATUS_DRAFT", "CONTRACT_STATUS_BUILDING", "CONTRACT_STATUS_ACTIVE" ] }, "strategies": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.ContractStrategy" } }, "type": { "type": "string", "enum": [ "CONTRACT_TYPE_UNSPECIFIED", "CONTRACT_TYPE_BUYING", "CONTRACT_TYPE_SELLING" ] }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the contract was last modified." }, "valuation": { "$ref": "#/components/schemas/contracts.v1.Valuation" }, "version": { "type": "string", "format": "int64", "description": "Optimistic concurrency version; incremented on every update." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the contract belongs to." } } }, "contracts.v1.ContractLimits": { "type": "object", "properties": { "maxOwnedPerItem": { "type": "integer", "format": "int32" }, "purchaseWindow": { "$ref": "#/components/schemas/contracts.v1.PurchaseWindow" }, "spendWindow": { "$ref": "#/components/schemas/contracts.v1.SpendWindow" } } }, "contracts.v1.ContractStatusCount": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Number of contracts in this status." }, "status": { "type": "string", "description": "The contract status this count is for.", "enum": [ "CONTRACT_STATUS_UNSPECIFIED", "CONTRACT_STATUS_DRAFT", "CONTRACT_STATUS_BUILDING", "CONTRACT_STATUS_ACTIVE" ] } } }, "contracts.v1.ContractStrategy": { "type": "object", "properties": { "csfloatAuction": { "$ref": "#/components/schemas/contracts.v1.CSFloatAuctionStrategy" }, "csfloatBuyOrder": { "$ref": "#/components/schemas/contracts.v1.CSFloatBuyOrderStrategy" }, "csfloatOffer": { "$ref": "#/components/schemas/contracts.v1.CSFloatOfferStrategy" }, "csfloatScraping": { "$ref": "#/components/schemas/contracts.v1.CSFloatScrapingStrategy" }, "csfloatSell": { "$ref": "#/components/schemas/contracts.v1.CSFloatSellStrategy" }, "offerHandling": { "$ref": "#/components/schemas/contracts.v1.OfferHandlingStrategy" }, "saleAccept": { "$ref": "#/components/schemas/contracts.v1.SaleAcceptStrategy" }, "salespanelSell": { "$ref": "#/components/schemas/contracts.v1.SalesPanelSellStrategy" } } }, "contracts.v1.CountAccountGroupsRequest": { "type": "object" }, "contracts.v1.CountAccountGroupsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Number of account groups in the caller's workspace." } } }, "contracts.v1.CountContractsRequest": { "type": "object", "properties": { "type": { "type": "string", "description": "Optional filter: count only contracts of this type.", "enum": [ "CONTRACT_TYPE_UNSPECIFIED", "CONTRACT_TYPE_BUYING", "CONTRACT_TYPE_SELLING" ] } } }, "contracts.v1.CountContractsResponse": { "type": "object", "properties": { "counts": { "type": "array", "description": "Count of contracts in each status, scoped to the workspace and optional type filter. A status with no contracts may be omitted.", "items": { "$ref": "#/components/schemas/contracts.v1.ContractStatusCount" } } } }, "contracts.v1.CountFilterSetsRequest": { "type": "object" }, "contracts.v1.CountFilterSetsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Number of filter sets in the caller's workspace." } } }, "contracts.v1.CountInventoryItemsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Optional filter: count only items attributed to this contract." } } }, "contracts.v1.CountInventoryItemsResponse": { "type": "object", "properties": { "counts": { "type": "array", "description": "Count of inventory items in each status, scoped to the workspace and optional contract filter. A status with no items may be omitted.", "items": { "$ref": "#/components/schemas/contracts.v1.InventoryItemStatusCount" } } } }, "contracts.v1.CountPurchasesRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Optional filter: count only purchases attributed to this contract." } } }, "contracts.v1.CountPurchasesResponse": { "type": "object", "properties": { "counts": { "type": "array", "description": "Count of purchases in each status, scoped to the workspace and optional contract filter. A status with no purchases may be omitted.", "items": { "$ref": "#/components/schemas/contracts.v1.PurchaseStatusCount" } } } }, "contracts.v1.CountSnapshotsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract to count snapshots for." } } }, "contracts.v1.CountSnapshotsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Total number of snapshots for this contract." } } }, "contracts.v1.CreateAccountGroupRequest": { "type": "object", "properties": { "members": { "type": "array", "description": "Steam account names that belong to the group.", "items": { "type": "string" } }, "name": { "type": "string", "description": "Human-readable account group name." } } }, "contracts.v1.CreateAccountGroupResponse": { "type": "object", "properties": { "accountGroup": { "$ref": "#/components/schemas/contracts.v1.AccountGroup" } } }, "contracts.v1.CreateContractRequest": { "type": "object", "properties": { "accountGroupId": { "type": "string", "format": "byte" }, "description": { "type": "string" }, "limits": { "$ref": "#/components/schemas/contracts.v1.ContractLimits" }, "name": { "type": "string" }, "predicate": { "$ref": "#/components/schemas/contracts.v1.Predicate" }, "strategies": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.ContractStrategy" } }, "type": { "type": "string", "enum": [ "CONTRACT_TYPE_UNSPECIFIED", "CONTRACT_TYPE_BUYING", "CONTRACT_TYPE_SELLING" ] }, "valuation": { "$ref": "#/components/schemas/contracts.v1.Valuation" } } }, "contracts.v1.CreateContractResponse": { "type": "object", "properties": { "contract": { "$ref": "#/components/schemas/contracts.v1.Contract" } } }, "contracts.v1.CreateFilterSetRequest": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "predicate": { "$ref": "#/components/schemas/contracts.v1.Predicate" } } }, "contracts.v1.CreateFilterSetResponse": { "type": "object", "properties": { "filterSet": { "$ref": "#/components/schemas/contracts.v1.FilterSet" } } }, "contracts.v1.DeleteAccountGroupRequest": { "type": "object", "properties": { "accountGroupId": { "type": "string", "format": "byte", "description": "Account group identifier." } } }, "contracts.v1.DeleteAccountGroupResponse": { "type": "object" }, "contracts.v1.DeleteContractRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte" } } }, "contracts.v1.DeleteContractResponse": { "type": "object" }, "contracts.v1.DeleteFilterSetRequest": { "type": "object", "properties": { "filterSetId": { "type": "string", "format": "byte" } } }, "contracts.v1.DeleteFilterSetResponse": { "type": "object" }, "contracts.v1.FilterSet": { "type": "object", "description": "A named, reusable predicate fragment a workspace references across contracts.", "properties": { "createdAt": { "type": "string", "format": "date-time", "description": "When the filter set was created." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the filter set was soft-deleted, if it has been." }, "description": { "type": "string", "description": "Free-form filter set description." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte filter set identifier, base64-encoded in JSON.", "example": "EBESExQVFhcYGRobHB0eHw==" }, "name": { "type": "string", "description": "Human-readable filter set name." }, "predicate": { "description": "The reusable predicate fragment this filter set expands into.", "$ref": "#/components/schemas/contracts.v1.Predicate" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the filter set was last modified." }, "version": { "type": "string", "format": "int64", "description": "Optimistic concurrency version; incremented on every update." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the filter set belongs to." } } }, "contracts.v1.FilterSetReference": { "type": "object", "properties": { "filterSetId": { "type": "string", "format": "byte", "description": "Identifier of the referenced filter set. Must belong to the same workspace as the contract; the contracts worker expands it into its predicate fragment before evaluation." } } }, "contracts.v1.Freshness": { "type": "object", "properties": { "days": { "type": "integer", "format": "int32" }, "hours": { "type": "integer", "format": "int32" }, "minutes": { "type": "integer", "format": "int32" } } }, "contracts.v1.GetAccountGroupRequest": { "type": "object", "properties": { "accountGroupId": { "type": "string", "format": "byte", "description": "Account group identifier." } }, "required": [ "accountGroupId" ] }, "contracts.v1.GetAccountGroupResponse": { "type": "object", "properties": { "accountGroup": { "description": "The requested account group.", "$ref": "#/components/schemas/contracts.v1.AccountGroup" } } }, "contracts.v1.GetAccountGroupsRequest": { "type": "object", "properties": { "accountGroupIds": { "type": "array", "description": "Account group identifiers to fetch.", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetAccountGroupsResponse": { "type": "object", "properties": { "accountGroups": { "type": "array", "description": "The account groups that were found.", "items": { "$ref": "#/components/schemas/contracts.v1.AccountGroup" } }, "notFoundIds": { "type": "array", "description": "Requested IDs that did not resolve to an account group.", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetContractRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract identifier.", "example": "EBESExQVFhcYGRobHB0eHw==" } }, "required": [ "contractId" ] }, "contracts.v1.GetContractResponse": { "type": "object", "properties": { "contract": { "description": "The requested contract.", "$ref": "#/components/schemas/contracts.v1.Contract" } } }, "contracts.v1.GetContractsRequest": { "type": "object", "properties": { "contractIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetContractsResponse": { "type": "object", "properties": { "contracts": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.Contract" } }, "notFoundIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetFilterSetRequest": { "type": "object", "properties": { "filterSetId": { "type": "string", "format": "byte", "description": "Filter set identifier." } }, "required": [ "filterSetId" ] }, "contracts.v1.GetFilterSetResponse": { "type": "object", "properties": { "filterSet": { "description": "The requested filter set.", "$ref": "#/components/schemas/contracts.v1.FilterSet" } } }, "contracts.v1.GetFilterSetsRequest": { "type": "object", "properties": { "filterSetIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetFilterSetsResponse": { "type": "object", "properties": { "filterSets": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.FilterSet" } }, "notFoundIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetIntentRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract the intent belongs to." }, "intentId": { "type": "string", "format": "byte", "description": "Intent identifier." }, "snapshotId": { "type": "string", "format": "int64", "description": "Evaluation snapshot the intent belongs to." } } }, "contracts.v1.GetIntentResponse": { "type": "object", "properties": { "intent": { "description": "The requested intent.", "$ref": "#/components/schemas/contracts.v1.Intent" } } }, "contracts.v1.GetIntentsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract the intents belong to." }, "intentIds": { "type": "array", "description": "Intent identifiers to fetch.", "items": { "type": "string", "format": "byte" } }, "snapshotId": { "type": "string", "format": "int64", "description": "Evaluation snapshot the intents belong to." } } }, "contracts.v1.GetIntentsResponse": { "type": "object", "properties": { "intents": { "type": "array", "description": "The intents that were found.", "items": { "$ref": "#/components/schemas/contracts.v1.Intent" } }, "notFoundIds": { "type": "array", "description": "Requested intent ids that did not resolve.", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetInventoryItemRequest": { "type": "object", "properties": { "inventoryItemId": { "type": "string", "format": "byte", "description": "Inventory item identifier.", "example": "aW52ZW50b3J5LWl0ZW0tMDAx" } }, "required": [ "inventoryItemId" ] }, "contracts.v1.GetInventoryItemResponse": { "type": "object", "properties": { "inventoryItem": { "description": "The requested inventory item.", "$ref": "#/components/schemas/contracts.v1.InventoryItem" } } }, "contracts.v1.GetInventoryItemsRequest": { "type": "object", "properties": { "inventoryItemIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetInventoryItemsResponse": { "type": "object", "properties": { "inventoryItems": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.InventoryItem" } }, "notFoundIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetPnLBreakdownRequest": { "type": "object", "properties": { "endTime": { "type": "string", "format": "date-time", "description": "Optional end of the time range that filters the realized components on sale completion time. The unrealized half of by_contract ignores this range." }, "startTime": { "type": "string", "format": "date-time", "description": "Optional start of the time range that filters the realized components (the whole by_market split and the realized half of by_contract) on sale completion time. The unrealized half of by_contract ignores this range." } } }, "contracts.v1.GetPnLBreakdownResponse": { "type": "object", "properties": { "byContract": { "type": "array", "description": "Realized and unrealized profit and loss grouped by contract, one row per contract.", "items": { "$ref": "#/components/schemas/contracts.v1.PnLByContract" } }, "byMarket": { "type": "array", "description": "Realized profit and loss grouped by selling marketplace.", "items": { "$ref": "#/components/schemas/contracts.v1.PnLByMarket" } } } }, "contracts.v1.GetPnLPeriodsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Optional filter: scope the period series to one contract instead of the whole workspace." }, "endTime": { "type": "string", "format": "date-time", "description": "End of the period range. The request is rejected when unset." }, "granularity": { "type": "string", "description": "Time bucket size for the series: \"day\", \"week\", or \"month\". The request is rejected when set to any other value.", "example": "month" }, "startTime": { "type": "string", "format": "date-time", "description": "Start of the period range. The request is rejected when unset." } } }, "contracts.v1.GetPnLPeriodsResponse": { "type": "object", "properties": { "periods": { "type": "array", "description": "The P\u0026L time series, one entry per bucket across the requested range.", "items": { "$ref": "#/components/schemas/contracts.v1.PnLPeriod" } } } }, "contracts.v1.GetPnLSummaryRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Optional filter: scope the summary to one contract's realized and unrealized figures instead of the whole workspace." }, "endTime": { "type": "string", "format": "date-time", "description": "Optional end of the time range that filters the realized components on sale completion time. The unrealized and lifetime buy components ignore this range." }, "startTime": { "type": "string", "format": "date-time", "description": "Optional start of the time range that filters the realized components (sell revenue, realized P\u0026L, and sold-item counts) on sale completion time. The unrealized and lifetime buy components ignore this range." } } }, "contracts.v1.GetPnLSummaryResponse": { "type": "object", "properties": { "summary": { "description": "The requested aggregate profit and loss summary.", "$ref": "#/components/schemas/contracts.v1.PnLSummary" } } }, "contracts.v1.GetPurchaseRequest": { "type": "object", "properties": { "purchaseId": { "type": "string", "format": "byte", "description": "Purchase identifier.", "example": "MDEyMzQ1Njc4OWFiY2RlZg==" } }, "required": [ "purchaseId" ] }, "contracts.v1.GetPurchaseResponse": { "type": "object", "properties": { "purchase": { "description": "The requested purchase.", "$ref": "#/components/schemas/contracts.v1.Purchase" } } }, "contracts.v1.GetPurchasesRequest": { "type": "object", "properties": { "purchaseIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetPurchasesResponse": { "type": "object", "properties": { "notFoundIds": { "type": "array", "items": { "type": "string", "format": "byte" } }, "purchases": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.Purchase" } } } }, "contracts.v1.GetSnapshotRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract the snapshot belongs to." }, "snapshotId": { "type": "string", "format": "int64", "description": "Snapshot identifier." } } }, "contracts.v1.GetSnapshotResponse": { "type": "object", "properties": { "snapshot": { "description": "The requested snapshot.", "$ref": "#/components/schemas/contracts.v1.Snapshot" } } }, "contracts.v1.GetSnapshotsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract the snapshots belong to." }, "snapshotIds": { "type": "array", "description": "Snapshot identifiers to fetch.", "items": { "type": "string", "format": "int64" } } } }, "contracts.v1.GetSnapshotsResponse": { "type": "object", "properties": { "notFoundIds": { "type": "array", "description": "Requested snapshot ids that did not resolve.", "items": { "type": "string", "format": "int64" } }, "snapshots": { "type": "array", "description": "The snapshots that were found.", "items": { "$ref": "#/components/schemas/contracts.v1.Snapshot" } } } }, "contracts.v1.GetTransitionRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract the transition belongs to." }, "fromSnapshotId": { "type": "string", "format": "int64", "description": "Earlier snapshot in the pair the transition diffs." }, "toSnapshotId": { "type": "string", "format": "int64", "description": "Later snapshot in the pair the transition diffs." }, "transitionId": { "type": "string", "format": "byte", "description": "Transition identifier." } } }, "contracts.v1.GetTransitionResponse": { "type": "object", "properties": { "transition": { "description": "The requested transition.", "$ref": "#/components/schemas/contracts.v1.Transition" } } }, "contracts.v1.GetTransitionsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract the transitions belong to." }, "fromSnapshotId": { "type": "string", "format": "int64", "description": "Earlier snapshot in the pair the transitions diff." }, "toSnapshotId": { "type": "string", "format": "int64", "description": "Later snapshot in the pair the transitions diff." }, "transitionIds": { "type": "array", "description": "Transition identifiers to fetch.", "items": { "type": "string", "format": "byte" } } } }, "contracts.v1.GetTransitionsResponse": { "type": "object", "properties": { "notFoundIds": { "type": "array", "description": "Requested transition ids that did not resolve.", "items": { "type": "string", "format": "byte" } }, "transitions": { "type": "array", "description": "The transitions that were found.", "items": { "$ref": "#/components/schemas/contracts.v1.Transition" } } } }, "contracts.v1.Intent": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract that produced this intent." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the intent was created." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the intent was soft-deleted, if it has been." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte intent identifier, base64-encoded in JSON. Exists only for API addressability; the intent's business identity is (contract, snapshot, market_hash_name)." }, "marketHashName": { "type": "string", "description": "The item this intent matched, e.g. \"AK-47 | Redline (Field-Tested)\"." }, "maxBuyPriceCents": { "type": "string", "format": "int64", "description": "The price this intent will pay (a buying contract) or list at (a selling contract), computed by the contract's valuation." }, "maxFloat": { "type": "number", "format": "double", "description": "Predicate float window upper bound; 1.0 means no upper bound." }, "minFloat": { "type": "number", "format": "double", "description": "Predicate float window lower bound; 0.0 means no lower bound." }, "referencePrices": { "type": "array", "description": "Per-reference price breakdown behind max_buy_price_cents, pinning each valuation reference's resolved source price at this snapshot.", "items": { "$ref": "#/components/schemas/contracts.v1.ReferencePrice" } }, "snapshotId": { "type": "string", "format": "int64", "description": "Evaluation snapshot this intent was produced by." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the intent was last modified." } } }, "contracts.v1.InventoryItem": { "type": "object", "description": "An item owned by a workspace, tracked from purchase through listing and sale. Exposes the current Steam asset_id so callers can reconcile against Steam inventory endpoints.", "properties": { "buyPriceCents": { "type": "string", "format": "int64", "description": "Price paid when this item was purchased, in cents." }, "contractId": { "type": "string", "format": "byte", "description": "Contract that originally bought the item." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the inventory item was created." }, "currentAssetId": { "type": "string", "description": "Current Steam asset_id. Steam rotates this value on every trade; use ListAssetIDLinks to see the full history.", "example": "29384710999" }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the inventory item was soft-deleted. Unset for active items." }, "floatValue": { "type": "number", "format": "double", "description": "The bought item's real Steam float value, recorded at purchase for sell-side float-window matching and audit. Unset when no real float was recorded, distinct from a 0.0 wear." }, "iconUrl": { "type": "string", "description": "Per-instance Valve economy icon hash for this exact item, rendered at community.cloudflare.steamstatic.com/economy/image/{icon_url}. Empty falls back to the catalog per-finish base icon." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte inventory item identifier." }, "marketHashName": { "type": "string", "description": "Canonical Steam market_hash_name of the owned item." }, "purchaseId": { "type": "string", "format": "byte", "description": "Purchase that produced this inventory item." }, "sellPriceCents": { "type": "string", "format": "int64", "description": "Price received when this item was sold, in cents. Unset until the sale completes." }, "status": { "type": "string", "description": "Current inventory item lifecycle state.", "enum": [ "INVENTORY_ITEM_STATUS_UNSPECIFIED", "INVENTORY_ITEM_STATUS_PENDING_TRADE", "INVENTORY_ITEM_STATUS_IN_INVENTORY", "INVENTORY_ITEM_STATUS_LISTED", "INVENTORY_ITEM_STATUS_SOLD" ] }, "tradable": { "type": "boolean", "description": "Steam's authoritative per-item tradable flag. False while the item is under a post-trade hold. The sell-candidate read (ListInventoryItems with sellable_only) excludes any item that is not tradable, so it is the safety floor that keeps a held item off every venue." }, "tradableAfter": { "type": "string", "format": "date-time", "description": "When a held item's post-trade hold lifts, parsed from Steam. Unset when there is no hold or when Steam withheld a parseable date for a held item; the precise reactivation and Tradable-after badge signal." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the inventory item was last modified." }, "version": { "type": "string", "format": "int64", "description": "Optimistic concurrency version; incremented on every update." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace that owns the item." } } }, "contracts.v1.InventoryItemStatusCount": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Number of inventory items in this status." }, "status": { "type": "string", "description": "The inventory item status this count is for.", "enum": [ "INVENTORY_ITEM_STATUS_UNSPECIFIED", "INVENTORY_ITEM_STATUS_PENDING_TRADE", "INVENTORY_ITEM_STATUS_IN_INVENTORY", "INVENTORY_ITEM_STATUS_LISTED", "INVENTORY_ITEM_STATUS_SOLD" ] } } }, "contracts.v1.Lag": { "type": "object", "properties": { "days": { "type": "integer", "format": "int32" } } }, "contracts.v1.ListAccountGroupsRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListAccountGroupsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of IDs to return. Server caps this at a service-defined upper bound." } } }, "contracts.v1.ListAccountGroupsResponse": { "type": "object", "properties": { "accountGroups": { "type": "array", "description": "Full account groups for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetAccountGroups.", "items": { "$ref": "#/components/schemas/contracts.v1.AccountGroup" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "contracts.v1.ListAssetIDLinksRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListAssetIDLinksResponse. Empty for the first page." }, "inventoryItemId": { "type": "string", "format": "byte", "description": "Inventory item whose asset_id chain should be returned.", "example": "aW52ZW50b3J5LWl0ZW0tMDAx" }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of links to return. Server caps this at a service-defined upper bound.", "example": 50 } }, "required": [ "inventoryItemId" ] }, "contracts.v1.ListAssetIDLinksResponse": { "type": "object", "properties": { "assetIdLinks": { "type": "array", "description": "Asset ID links for this page, ordered by step.", "items": { "$ref": "#/components/schemas/contracts.v1.AssetIDLink" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "contracts.v1.ListContractsRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListContractsResponse. Empty for the first page." }, "descending": { "type": "boolean", "description": "Order descending instead of ascending." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of contracts to return. Server caps this at a service-defined upper bound.", "example": 50 }, "sortField": { "type": "string", "description": "Field to order the page by. Unspecified orders by creation time.", "enum": [ "CONTRACT_SORT_FIELD_UNSPECIFIED", "CONTRACT_SORT_FIELD_CREATED_AT", "CONTRACT_SORT_FIELD_NAME", "CONTRACT_SORT_FIELD_UPDATED_AT" ] }, "status": { "type": "array", "description": "Optional filter: return only contracts in these statuses. Empty returns every status. Sorting and filtering are server side, so the client passes the active tab here rather than filtering a fetched page.", "items": { "type": "string", "enum": [ "CONTRACT_STATUS_UNSPECIFIED", "CONTRACT_STATUS_DRAFT", "CONTRACT_STATUS_BUILDING", "CONTRACT_STATUS_ACTIVE" ] } }, "type": { "type": "string", "description": "Optional filter: return only contracts of this type.", "enum": [ "CONTRACT_TYPE_UNSPECIFIED", "CONTRACT_TYPE_BUYING", "CONTRACT_TYPE_SELLING" ] } } }, "contracts.v1.ListContractsResponse": { "type": "object", "properties": { "contracts": { "type": "array", "description": "Full contracts for this page, ordered by the requested sort. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetContracts.", "items": { "$ref": "#/components/schemas/contracts.v1.Contract" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "contracts.v1.ListFilterSetsRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListFilterSetsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of IDs to return. Server caps this at a service-defined upper bound." } } }, "contracts.v1.ListFilterSetsResponse": { "type": "object", "properties": { "filterSets": { "type": "array", "description": "Full filter sets for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetFilterSets.", "items": { "$ref": "#/components/schemas/contracts.v1.FilterSet" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "contracts.v1.ListIntentsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract to list intents from." }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListIntentsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of intents to return. Server caps this at a service-defined upper bound." }, "snapshotId": { "type": "string", "format": "int64", "description": "Evaluation snapshot to list intents from." } } }, "contracts.v1.ListIntentsResponse": { "type": "object", "properties": { "intents": { "type": "array", "description": "Full intents for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetIntents.", "items": { "$ref": "#/components/schemas/contracts.v1.Intent" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "contracts.v1.ListInventoryItemsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Optional filter: return only items attributed to this contract." }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListInventoryItemsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of IDs to return. Server caps this at a service-defined upper bound.", "example": 100 }, "sellableOnly": { "type": "boolean", "description": "When true, exclude any item still inside Valve's post-trade hold: any row that is not tradable or whose tradable_after is still in the future. Set by every selling market service so the hold logic lives in contracts once and no venue offers an undeliverable held item." }, "status": { "type": "string", "description": "Optional filter: return only items in this lifecycle state.", "enum": [ "INVENTORY_ITEM_STATUS_UNSPECIFIED", "INVENTORY_ITEM_STATUS_PENDING_TRADE", "INVENTORY_ITEM_STATUS_IN_INVENTORY", "INVENTORY_ITEM_STATUS_LISTED", "INVENTORY_ITEM_STATUS_SOLD" ] } } }, "contracts.v1.ListInventoryItemsResponse": { "type": "object", "properties": { "inventoryItems": { "type": "array", "description": "Full inventory items for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetInventoryItems.", "items": { "$ref": "#/components/schemas/contracts.v1.InventoryItem" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "contracts.v1.ListPurchasesRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Optional filter: return only purchases attributed to this contract." }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListPurchasesResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of IDs to return. Server caps this at a service-defined upper bound.", "example": 100 }, "status": { "type": "string", "description": "Optional filter: return only purchases in this lifecycle state.", "enum": [ "PURCHASE_STATUS_UNSPECIFIED", "PURCHASE_STATUS_PENDING", "PURCHASE_STATUS_COMPLETED", "PURCHASE_STATUS_FAILED", "PURCHASE_STATUS_TRADES_PENDING", "PURCHASE_STATUS_TRADED", "PURCHASE_STATUS_ROLLED_BACK" ] } } }, "contracts.v1.ListPurchasesResponse": { "type": "object", "properties": { "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." }, "purchases": { "type": "array", "description": "Full purchases for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetPurchases.", "items": { "$ref": "#/components/schemas/contracts.v1.Purchase" } } } }, "contracts.v1.ListSnapshotsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract to list snapshots from." }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListSnapshotsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of snapshots to return. Server caps this at a service-defined upper bound." } } }, "contracts.v1.ListSnapshotsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." }, "snapshots": { "type": "array", "description": "Full snapshots for this page, most recent first. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetSnapshots.", "items": { "$ref": "#/components/schemas/contracts.v1.Snapshot" } } } }, "contracts.v1.ListTransitionsRequest": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract to list transitions from." }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListTransitionsResponse. Empty for the first page." }, "fromSnapshotId": { "type": "string", "format": "int64", "description": "Optional filter: only transitions whose earlier snapshot is this one." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of transitions to return. Server caps this at a service-defined upper bound." }, "toSnapshotId": { "type": "string", "format": "int64", "description": "Optional filter: only transitions whose later snapshot is this one." } } }, "contracts.v1.ListTransitionsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." }, "transitions": { "type": "array", "description": "Full transitions for this page. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetTransitions.", "items": { "$ref": "#/components/schemas/contracts.v1.Transition" } } } }, "contracts.v1.ListWorkspaceIntentRollupRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListWorkspaceIntentRollupResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of rows to return. Server caps this at a service-defined upper bound (1000) and defaults to it when unset." }, "query": { "type": "string", "description": "Optional case-insensitive substring filter on market_hash_name, matched server side. Empty returns every row." }, "side": { "type": "string", "description": "Which intent direction to roll up: \"buy\" or \"sell\". No other value is accepted.", "example": "buy" } } }, "contracts.v1.ListWorkspaceIntentRollupResponse": { "type": "object", "properties": { "items": { "type": "array", "description": "This workspace's own intent rollup rows for the requested side, ranked by top_price_cents descending.", "items": { "$ref": "#/components/schemas/contracts.v1.WorkspaceIntentRollupItem" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "contracts.v1.MarketDataField": { "type": "object", "properties": { "freshness": { "description": "Maximum age of the observation this rule reads. Required, exactly one positive unit: an observation older than now minus freshness is treated as unavailable and the rule does not match.", "$ref": "#/components/schemas/contracts.v1.Freshness" }, "metric": { "type": "string", "description": "Name of the market-observation metric to resolve, for example a source's 7-day sales volume." }, "source": { "type": "string", "description": "Market-data source the metric is resolved against.", "example": "market-csgo" } } }, "contracts.v1.OfferHandlingStrategy": { "type": "object", "properties": { "autoDecline": { "type": "boolean" }, "minOfferAcceptPct": { "type": "number", "format": "double" } } }, "contracts.v1.Outlier": { "type": "object", "properties": { "sigma": { "type": "number", "format": "double" } } }, "contracts.v1.PnLByContract": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "The contract this row reports on." }, "itemsInInventory": { "type": "string", "format": "int64", "description": "Number of items this contract bought and still holds." }, "itemsSold": { "type": "string", "format": "int64", "description": "Number of sold items this contract participated in as buyer or seller." }, "realizedPnlCents": { "type": "string", "format": "int64", "description": "The whole realized profit and loss of every sold item this contract participated in as buyer or seller, each such item counted once. Because an item's realized result is credited in full to both its buying and selling contract, these figures deliberately do not sum to the workspace total when the two differ." }, "unrealizedCostCents": { "type": "string", "format": "int64", "description": "Buy cost basis of items this contract bought and still holds, in cents." } } }, "contracts.v1.PnLByMarket": { "type": "object", "properties": { "itemsSold": { "type": "string", "format": "int64", "description": "Number of sold items settled by this venue." }, "marketplace": { "type": "string", "description": "The selling venue that settled the sale. \"unknown\" when the sale predates selling_marketplace and cannot be attributed.", "example": "csfloat" }, "realizedPnlCents": { "type": "string", "format": "int64", "description": "Realized profit and loss for the items this venue settled, in cents: the sum of sell_price_cents minus buy_price_cents over those sold items." }, "sellRevenueCents": { "type": "string", "format": "int64", "description": "Realized sell revenue settled by this venue, in cents: the sum of sell_price_cents over the sold items it settled." } } }, "contracts.v1.PnLPeriod": { "type": "object", "properties": { "buyCostCents": { "type": "string", "format": "int64", "description": "Cost of items purchased during this period, in cents: the sum of listing_price_cents for purchases made in this time bucket." }, "periodEnd": { "type": "string", "format": "date-time", "description": "End of this period's time bucket, inclusive." }, "periodStart": { "type": "string", "format": "date-time", "description": "Start of this period's time bucket, inclusive." }, "pnlCents": { "type": "string", "format": "int64", "description": "Realized profit and loss for items sold during this period, in cents: sell revenue minus buy cost for those same sold items, bucketed by sale completion time." }, "purchaseCount": { "type": "string", "format": "int64", "description": "Number of purchases made during this period." }, "sellRevenueCents": { "type": "string", "format": "int64", "description": "Realized sell revenue for items sold during this period, in cents: the sum of sell_price_cents for sales completed in this time bucket." } } }, "contracts.v1.PnLSummary": { "type": "object", "properties": { "itemsInInventory": { "type": "string", "format": "int64", "description": "Number of items in scope that are still held and not yet sold." }, "itemsSold": { "type": "string", "format": "int64", "description": "Number of items in scope that have sold." }, "realizedPnlCents": { "type": "string", "format": "int64", "description": "Realized profit and loss in scope, in cents: total_sell_revenue_cents minus the buy cost of those same sold items." }, "totalBuyCostCents": { "type": "string", "format": "int64", "description": "Lifetime buy cost in scope, in cents: the sum of listing_price_cents over every purchase, held and sold alike, for the workspace or for the one contract the request scoped to." }, "totalPurchases": { "type": "string", "format": "int64", "description": "Lifetime count of purchases in scope, held and sold alike." }, "totalSellRevenueCents": { "type": "string", "format": "int64", "description": "Realized sell revenue in scope, in cents: the sum of sell_price_cents over every sold item counted in this summary." }, "unrealizedCostCents": { "type": "string", "format": "int64", "description": "Unrealized cost in scope, in cents: the buy cost basis of items still held and not yet sold." } } }, "contracts.v1.Predicate": { "type": "object", "properties": { "filterSet": { "description": "This node is a reference to a named, reusable filter set, expanded into its fragment before evaluation.", "$ref": "#/components/schemas/contracts.v1.FilterSetReference" }, "group": { "description": "This node is a group: an AND/OR combination of child predicate nodes.", "$ref": "#/components/schemas/contracts.v1.PredicateGroup" }, "rule": { "description": "This node is a leaf rule: a single subject-operator-value condition.", "$ref": "#/components/schemas/contracts.v1.PredicateRule" } } }, "contracts.v1.PredicateGroup": { "type": "object", "properties": { "condition": { "type": "string", "description": "Logical combinator applied to rules: AND or OR.", "enum": [ "PREDICATE_CONDITION_UNSPECIFIED", "PREDICATE_CONDITION_AND", "PREDICATE_CONDITION_OR" ] }, "rules": { "type": "array", "description": "Child predicate nodes combined by condition. Must be non-empty.", "items": { "$ref": "#/components/schemas/contracts.v1.Predicate" } } } }, "contracts.v1.PredicateRule": { "type": "object", "properties": { "field": { "type": "string", "description": "This rule's subject is an item attribute, resolved against the items catalog.", "enum": [ "PREDICATE_FIELD_UNSPECIFIED", "PREDICATE_FIELD_MARKET_HASH_NAME", "PREDICATE_FIELD_CATEGORY", "PREDICATE_FIELD_WEAPON", "PREDICATE_FIELD_PAINT", "PREDICATE_FIELD_RARITY", "PREDICATE_FIELD_COLLECTION", "PREDICATE_FIELD_MIN_WEAR", "PREDICATE_FIELD_MAX_WEAR", "PREDICATE_FIELD_HAS_STAT_TRAK", "PREDICATE_FIELD_HAS_SOUVENIR", "PREDICATE_FIELD_ITEM_AGE_DAYS" ] }, "marketData": { "description": "This rule's subject is a (source, metric) market-observation value.", "$ref": "#/components/schemas/contracts.v1.MarketDataField" }, "operator": { "type": "string", "description": "Comparison operator applied to the subject's resolved value. Which operators are legal depends on the subject: field allows the full attribute operator set (narrowed to gte/gt for min_wear and lte/lt for max_wear), market_data allows only eq, neq, gt, gte, lt, lte, and value_field allows only gt, gte, lt, lte.", "enum": [ "PREDICATE_OPERATOR_UNSPECIFIED", "PREDICATE_OPERATOR_EQ", "PREDICATE_OPERATOR_NEQ", "PREDICATE_OPERATOR_IN", "PREDICATE_OPERATOR_NOT_IN", "PREDICATE_OPERATOR_GT", "PREDICATE_OPERATOR_GTE", "PREDICATE_OPERATOR_LT", "PREDICATE_OPERATOR_LTE", "PREDICATE_OPERATOR_CONTAINS", "PREDICATE_OPERATOR_NOT_CONTAINS" ] }, "value": { "description": "Right-hand side value the subject is compared against.", "$ref": "#/components/schemas/contracts.v1.PredicateValue" }, "valueField": { "type": "string", "description": "This rule's subject is the valuation's combined computed price for the item.", "enum": [ "PREDICATE_VALUE_FIELD_UNSPECIFIED", "PREDICATE_VALUE_FIELD_COMPUTED_PRICE" ] } } }, "contracts.v1.PredicateValue": { "type": "object", "properties": { "boolValue": { "type": "boolean", "description": "Boolean value, used when the subject's comparison is against a boolean item attribute such as has_stat_trak or has_souvenir." }, "numberValue": { "type": "number", "format": "double", "description": "Numeric value, used when the subject's comparison is against a number: a market-data bound, a computed-price bound, or a numeric item attribute." }, "stringListValue": { "description": "List of string values, used with the in and not_in operators.", "$ref": "#/components/schemas/contracts.v1.StringList" }, "stringValue": { "type": "string", "description": "String value, used when the subject's comparison is against text." } } }, "contracts.v1.Purchase": { "type": "object", "description": "A single item acquisition attributed to a workspace contract. Tracks the purchase from attribution through marketplace execution and Steam trade completion.", "properties": { "accountName": { "type": "string", "description": "Steam/marketplace account that executed the buy." }, "contractId": { "type": "string", "format": "byte", "description": "Contract that matched and won attribution for this purchase." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the purchase was attributed." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the purchase was soft-deleted. Unset for active purchases." }, "escrowEndDate": { "type": "string", "format": "date-time", "description": "The escrow hold's expected release date, when Steam reports one. Unset when Steam withheld the ETA, or when the delivery was never escrowed." }, "escrowedAt": { "type": "string", "format": "date-time", "description": "When the delivery was first observed in escrow. Unset when the delivery was never held." }, "failedAt": { "type": "string", "format": "date-time", "description": "When the purchase reached a terminal failure - failed or rolled_back. Unset for a purchase that has not failed." }, "flaggedForReviewAt": { "type": "string", "format": "date-time", "description": "When the stale-purchase reconciliation first flagged this purchase for manual review, having found it stuck past its delivery deadline. A durable, stamp-once audit fact; unset until flagged and never erased. The live needs-review set is the flagged purchases whose inventory item is still pending_trade." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte purchase identifier." }, "listingAssetId": { "type": "string", "description": "Steam asset ID recorded on the marketplace listing at purchase time." }, "listingId": { "type": "string", "description": "Marketplace listing identifier the item was purchased from." }, "listingPriceCents": { "type": "string", "format": "int64", "description": "Actual listing price paid on the marketplace, in cents." }, "marketHashName": { "type": "string", "description": "Canonical Steam market_hash_name of the item being purchased.", "example": "AK-47 | Redline (Field-Tested)" }, "marketplace": { "type": "string", "description": "Source marketplace slug.", "example": "csfloat" }, "maxBuyPriceCents": { "type": "string", "format": "int64", "description": "Maximum price the contract was willing to pay at attribution time, in cents." }, "overCeilingFlaggedAt": { "type": "string", "format": "date-time", "description": "When this purchase was recorded with a listing price above the winning intent's committed ceiling - a market-service bug that overpaid, making platform_fee_cents negative. Stamped once at record time inside AssignPurchase and never erased. A permanent needs-review contributor that does not self-clear as the item delivers, because a negative-fee loss stays visible through to manual resolution." }, "platformFeeCents": { "type": "string", "format": "int64", "description": "Platform fee (max_buy_price - listing_price), in cents." }, "purchasedAt": { "type": "string", "format": "date-time", "description": "When the purchase transitioned to completed - the buy executed and funds were committed. Unset while pending." }, "referencePrices": { "type": "array", "description": "Per-reference price breakdown of the winning intent behind max_buy_price_cents, so the purchase price is traceable to the exact source figures behind it.", "items": { "$ref": "#/components/schemas/contracts.v1.ReferencePrice" } }, "status": { "type": "string", "description": "Current purchase lifecycle state.", "enum": [ "PURCHASE_STATUS_UNSPECIFIED", "PURCHASE_STATUS_PENDING", "PURCHASE_STATUS_COMPLETED", "PURCHASE_STATUS_FAILED", "PURCHASE_STATUS_TRADES_PENDING", "PURCHASE_STATUS_TRADED", "PURCHASE_STATUS_ROLLED_BACK" ] }, "strategy": { "type": "string", "description": "Buying mechanism that produced the purchase, recorded as provenance: \"assignment\" (scrape-discovered listing) | \"buy_order\" (resting buy-order fill) | \"auction\" (auction win).", "example": "assignment" }, "tradedAt": { "type": "string", "format": "date-time", "description": "When the Steam trade completed and the item was received. Unset until traded." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the purchase was last modified." }, "version": { "type": "string", "format": "int64", "description": "Optimistic concurrency version; incremented on every status change." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the purchase belongs to." }, "wrongFloatFlaggedAt": { "type": "string", "format": "date-time", "description": "When this purchase was recorded with a float outside the winning intent's committed float window - a market-service bug that bought the wrong item. Stamped once at record time inside AssignPurchase and never erased. A permanent needs-review contributor that does not self-clear as the item delivers, because a wrong-item buy stays visible through to manual resolution." } } }, "contracts.v1.PurchaseStatusCount": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32", "description": "Number of purchases in this status." }, "status": { "type": "string", "description": "The purchase status this count is for.", "enum": [ "PURCHASE_STATUS_UNSPECIFIED", "PURCHASE_STATUS_PENDING", "PURCHASE_STATUS_COMPLETED", "PURCHASE_STATUS_FAILED", "PURCHASE_STATUS_TRADES_PENDING", "PURCHASE_STATUS_TRADED", "PURCHASE_STATUS_ROLLED_BACK" ] } } }, "contracts.v1.PurchaseWindow": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "days": { "type": "integer", "format": "int32" } } }, "contracts.v1.ReferencePrice": { "type": "object", "properties": { "metric": { "type": "string" }, "priceCents": { "type": "string", "format": "int64" }, "referenceIndex": { "type": "integer", "format": "int32" }, "source": { "type": "string" }, "valueCents": { "type": "string", "format": "int64" } } }, "contracts.v1.SaleAcceptStrategy": { "type": "object", "properties": { "delaySeconds": { "type": "integer", "format": "int32" } } }, "contracts.v1.SalesPanelSellStrategy": { "type": "object", "properties": { "ceilingPct": { "type": "number", "format": "double" } } }, "contracts.v1.Snapshot": { "type": "object", "properties": { "added": { "type": "string", "format": "int64", "description": "Number of intents newly added in this snapshot, compared to the previous one." }, "contractId": { "type": "string", "format": "byte", "description": "Contract this snapshot evaluated." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the snapshot was created." }, "deleted": { "type": "string", "format": "int64", "description": "Number of intents removed in this snapshot, compared to the previous one." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the snapshot was soft-deleted, if it has been." }, "id": { "type": "string", "format": "int64", "description": "Snapshot sequence number, monotonic per contract; the first snapshot is 1." }, "total": { "type": "string", "format": "int64", "description": "Total number of intents in effect after this snapshot." }, "updated": { "type": "string", "format": "int64", "description": "Number of intents whose price or float window changed in this snapshot, compared to the previous one." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the snapshot was last modified." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the snapshot's contract belongs to." } } }, "contracts.v1.SpendWindow": { "type": "object", "properties": { "amountCents": { "type": "string", "format": "int64" }, "days": { "type": "integer", "format": "int32" } } }, "contracts.v1.StringList": { "type": "object", "properties": { "values": { "type": "array", "description": "The wrapped list of string values.", "items": { "type": "string" } } } }, "contracts.v1.Transition": { "type": "object", "properties": { "contractId": { "type": "string", "format": "byte", "description": "Contract this transition belongs to." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the transition was created." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the transition was soft-deleted, if it has been." }, "fromSnapshotId": { "type": "string", "format": "int64", "description": "Earlier snapshot in the pair this transition diffs." }, "id": { "type": "string", "format": "byte", "description": "Opaque 16-byte transition identifier, base64-encoded in JSON." }, "marketHashName": { "type": "string", "description": "The item that changed between the two snapshots." }, "toSnapshotId": { "type": "string", "format": "int64", "description": "Later snapshot in the pair this transition diffs." }, "type": { "type": "string", "description": "Kind of change this transition represents: add, remove, or update." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the transition was last modified." } } }, "contracts.v1.UpdateAccountGroupRequest": { "type": "object", "properties": { "accountGroupId": { "type": "string", "format": "byte", "description": "Account group identifier." }, "members": { "type": "array", "description": "When non-empty, replaces the full membership. proto3 repeated fields carry no presence, so an empty list reads the same as an omitted one and both leave the membership unchanged; a group is emptied by deleting it, not by an empty update.", "items": { "type": "string" } }, "name": { "type": "string", "description": "New name. Omitted leaves the name unchanged." } } }, "contracts.v1.UpdateAccountGroupResponse": { "type": "object", "properties": { "accountGroup": { "$ref": "#/components/schemas/contracts.v1.AccountGroup" } } }, "contracts.v1.UpdateContractRequest": { "type": "object", "properties": { "accountGroupId": { "type": "string", "format": "byte" }, "contractId": { "type": "string", "format": "byte" }, "description": { "type": "string" }, "limits": { "$ref": "#/components/schemas/contracts.v1.ContractLimits" }, "name": { "type": "string" }, "predicate": { "$ref": "#/components/schemas/contracts.v1.Predicate" }, "status": { "type": "string", "enum": [ "CONTRACT_STATUS_UNSPECIFIED", "CONTRACT_STATUS_DRAFT", "CONTRACT_STATUS_BUILDING", "CONTRACT_STATUS_ACTIVE" ] }, "strategies": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.ContractStrategy" } }, "type": { "type": "string", "enum": [ "CONTRACT_TYPE_UNSPECIFIED", "CONTRACT_TYPE_BUYING", "CONTRACT_TYPE_SELLING" ] }, "valuation": { "$ref": "#/components/schemas/contracts.v1.Valuation" } } }, "contracts.v1.UpdateContractResponse": { "type": "object", "properties": { "contract": { "$ref": "#/components/schemas/contracts.v1.Contract" } } }, "contracts.v1.UpdateFilterSetRequest": { "type": "object", "properties": { "description": { "type": "string" }, "filterSetId": { "type": "string", "format": "byte" }, "name": { "type": "string" }, "predicate": { "$ref": "#/components/schemas/contracts.v1.Predicate" } } }, "contracts.v1.UpdateFilterSetResponse": { "type": "object", "properties": { "filterSet": { "$ref": "#/components/schemas/contracts.v1.FilterSet" } } }, "contracts.v1.Valuation": { "type": "object", "properties": { "references": { "type": "array", "items": { "$ref": "#/components/schemas/contracts.v1.ValuationReference" } }, "strategy": { "type": "string", "enum": [ "VALUATION_STRATEGY_UNSPECIFIED", "VALUATION_STRATEGY_MIN", "VALUATION_STRATEGY_MAX", "VALUATION_STRATEGY_AVG" ] } } }, "contracts.v1.ValuationReference": { "type": "object", "properties": { "adjustment": { "type": "number", "format": "double" }, "aggregation": { "$ref": "#/components/schemas/contracts.v1.Aggregation" }, "freshness": { "description": "Maximum age of the observation a market-data lookup reads. Required for a market-data lookup (metric set); rejected for a sale computation (window/aggregation set).", "$ref": "#/components/schemas/contracts.v1.Freshness" }, "lag": { "$ref": "#/components/schemas/contracts.v1.Lag" }, "metric": { "type": "string" }, "outlier": { "$ref": "#/components/schemas/contracts.v1.Outlier" }, "percentile": { "type": "integer", "format": "int32" }, "source": { "type": "string" }, "window": { "$ref": "#/components/schemas/contracts.v1.Window" } } }, "contracts.v1.Window": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "days": { "type": "integer", "format": "int32" }, "hours": { "type": "integer", "format": "int32" } } }, "contracts.v1.WorkspaceIntentRollupItem": { "type": "object", "properties": { "marketHashName": { "type": "string", "description": "Canonical Steam market_hash_name of the item this row rolls up.", "example": "AK-47 | Redline (Field-Tested)" }, "maxFloat": { "type": "number", "format": "double", "description": "Float window upper bound. 1.0 means no upper bound." }, "minFloat": { "type": "number", "format": "double", "description": "Float window lower bound. 0.0 means no lower bound." }, "ownContributingCount": { "type": "integer", "format": "int32", "description": "Number of this workspace's own contracts contributing an active intent for this item, float window, and side." }, "side": { "type": "string", "description": "Which intent direction this row rolls up: \"buy\" or \"sell\".", "example": "buy" }, "topPriceCents": { "type": "string", "format": "int64", "description": "This workspace's own best price for this item, float window, and side, in cents: the buy ceiling for a buying intent or the computed list price for a selling intent." } } }, "proxies.v1.BulkAssignAccountsToPoolRequest": { "type": "object", "properties": { "accountNames": { "type": "array", "items": { "type": "string" } }, "poolId": { "type": "string", "format": "byte" } } }, "proxies.v1.BulkAssignAccountsToPoolResponse": { "type": "object", "properties": { "assignedCount": { "type": "integer", "format": "int32" } } }, "proxies.v1.BulkCreateAssignmentError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "BULK_CREATE_ASSIGNMENT_ERROR_CODE_UNSPECIFIED", "BULK_CREATE_ASSIGNMENT_ERROR_CODE_ALREADY_EXISTS", "BULK_CREATE_ASSIGNMENT_ERROR_CODE_INVALID", "BULK_CREATE_ASSIGNMENT_ERROR_CODE_SESSION_NOT_FOUND", "BULK_CREATE_ASSIGNMENT_ERROR_CODE_POOL_NOT_FOUND", "BULK_CREATE_ASSIGNMENT_ERROR_CODE_INTERNAL" ] }, "message": { "type": "string" } } }, "proxies.v1.BulkCreateAssignmentInput": { "type": "object", "properties": { "accountName": { "type": "string" }, "pinned": { "type": "boolean" }, "poolId": { "type": "string", "format": "byte" }, "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.BulkCreateAssignmentRequest": { "type": "object", "properties": { "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.BulkCreateAssignmentInput" } } } }, "proxies.v1.BulkCreateAssignmentResponse": { "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.BulkCreateAssignmentResult" } } } }, "proxies.v1.BulkCreateAssignmentResult": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "byte" }, "error": { "$ref": "#/components/schemas/proxies.v1.BulkCreateAssignmentError" } } }, "proxies.v1.BulkCreateSessionsRequest": { "type": "object", "properties": { "poolId": { "type": "string", "format": "byte" }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.CreateSessionInput" } } } }, "proxies.v1.BulkCreateSessionsResponse": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxiesSession" } } } }, "proxies.v1.ConnectProviderRequest": { "type": "object", "properties": { "credentials": { "type": "string", "format": "byte" }, "type": { "type": "string", "enum": [ "PROVIDER_TYPE_UNSPECIFIED", "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "PROVIDER_TYPE_WEBSHARE_STATIC", "PROVIDER_TYPE_PROXYLINE", "PROVIDER_TYPE_SUBORBITAL" ] } } }, "proxies.v1.ConnectProviderResponse": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/proxies.v1.ProxiesProvider" } } }, "proxies.v1.CountAssignmentsRequest": { "type": "object", "properties": { "accountName": { "type": "string" }, "poolId": { "type": "string", "format": "byte" }, "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.CountAssignmentsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "proxies.v1.CountPoolsRequest": { "type": "object" }, "proxies.v1.CountPoolsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "proxies.v1.CountProvidersRequest": { "type": "object" }, "proxies.v1.CountProvidersResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "proxies.v1.CountRemediationsRequest": { "type": "object", "properties": { "poolId": { "type": "string", "format": "byte" }, "status": { "type": "string" } } }, "proxies.v1.CountRemediationsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "proxies.v1.CountRenewalsRequest": { "type": "object", "properties": { "providerId": { "type": "string", "format": "byte" }, "status": { "type": "string" } } }, "proxies.v1.CountRenewalsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "proxies.v1.CountSessionsRequest": { "type": "object", "properties": { "poolId": { "type": "string", "format": "byte" } } }, "proxies.v1.CountSessionsResponse": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "proxies.v1.CreateAssignmentRequest": { "type": "object", "properties": { "accountName": { "type": "string" }, "pinned": { "type": "boolean" }, "poolId": { "type": "string", "format": "byte" }, "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.CreateAssignmentResponse": { "type": "object", "properties": { "assignment": { "$ref": "#/components/schemas/proxies.v1.ProxiesAssignment" } } }, "proxies.v1.CreateSessionInput": { "type": "object", "properties": { "host": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "scheme": { "type": "string" }, "token": { "type": "string" }, "username": { "type": "string" } } }, "proxies.v1.CreateSessionRequest": { "type": "object", "properties": { "host": { "type": "string" }, "password": { "type": "string" }, "poolId": { "type": "string", "format": "byte" }, "port": { "type": "integer", "format": "int32" }, "scheme": { "type": "string" }, "token": { "type": "string" }, "username": { "type": "string" } } }, "proxies.v1.CreateSessionResponse": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/proxies.v1.ProxiesSession" } } }, "proxies.v1.DeleteAssignmentRequest": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "byte" } } }, "proxies.v1.DeleteAssignmentResponse": { "type": "object" }, "proxies.v1.DeleteProviderRequest": { "type": "object", "properties": { "providerId": { "type": "string", "format": "byte" } } }, "proxies.v1.DeleteProviderResponse": { "type": "object" }, "proxies.v1.DeleteSessionRequest": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.DeleteSessionResponse": { "type": "object" }, "proxies.v1.GetAssignmentRequest": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "byte" } } }, "proxies.v1.GetAssignmentResponse": { "type": "object", "properties": { "assignment": { "$ref": "#/components/schemas/proxies.v1.ProxiesAssignment" } } }, "proxies.v1.GetPoolRequest": { "type": "object", "properties": { "poolId": { "type": "string", "format": "byte" } } }, "proxies.v1.GetPoolResponse": { "type": "object", "properties": { "pool": { "$ref": "#/components/schemas/proxies.v1.ProxiesPool" } } }, "proxies.v1.GetProviderRequest": { "type": "object", "properties": { "providerId": { "type": "string", "format": "byte" } } }, "proxies.v1.GetProviderResponse": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/proxies.v1.ProxiesProvider" } } }, "proxies.v1.GetRemediationRequest": { "type": "object", "properties": { "accountName": { "type": "string" } } }, "proxies.v1.GetRemediationResponse": { "type": "object", "properties": { "remediation": { "$ref": "#/components/schemas/proxies.v1.ProxiesRemediation" } } }, "proxies.v1.GetRenewalRequest": { "type": "object", "properties": { "renewalId": { "type": "string", "format": "byte" } } }, "proxies.v1.GetRenewalResponse": { "type": "object", "properties": { "renewal": { "$ref": "#/components/schemas/proxies.v1.ProxiesRenewal" } } }, "proxies.v1.GetSessionRequest": { "type": "object", "properties": { "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.GetSessionResponse": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/proxies.v1.ProxiesSession" } } }, "proxies.v1.ImportProxyListError": { "type": "object", "properties": { "code": { "type": "string", "enum": [ "IMPORT_PROXY_LIST_ERROR_CODE_UNSPECIFIED", "IMPORT_PROXY_LIST_ERROR_CODE_INVALID" ] }, "message": { "type": "string" } } }, "proxies.v1.ImportProxyListRequest": { "type": "object", "properties": { "poolName": { "type": "string" }, "rows": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxyImportRow" } } } }, "proxies.v1.ImportProxyListResponse": { "type": "object", "properties": { "poolId": { "type": "string", "format": "byte" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ImportProxyRowResult" } } } }, "proxies.v1.ImportProxyRowResult": { "type": "object", "properties": { "error": { "$ref": "#/components/schemas/proxies.v1.ImportProxyListError" }, "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.ListAssignmentsRequest": { "type": "object", "properties": { "accountName": { "type": "string" }, "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "poolId": { "type": "string", "format": "byte" }, "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.ListAssignmentsResponse": { "type": "object", "properties": { "assignments": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxiesAssignment" } }, "nextCursor": { "type": "string" } } }, "proxies.v1.ListPoolsRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "descending": { "type": "boolean" }, "limit": { "type": "integer", "format": "int32" }, "sortField": { "type": "string", "enum": [ "POOL_SORT_FIELD_UNSPECIFIED", "POOL_SORT_FIELD_CREATED_AT", "POOL_SORT_FIELD_PROXY_COUNT" ] } } }, "proxies.v1.ListPoolsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "pools": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxiesPool" } } } }, "proxies.v1.ListProvidersRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListProvidersResponse. Empty for the first page." }, "descending": { "type": "boolean", "description": "Order descending instead of ascending." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of providers to return. Server caps this at a service-defined upper bound." }, "sortField": { "type": "string", "description": "Field to order the page by. Unspecified orders by creation time.", "enum": [ "PROVIDER_SORT_FIELD_UNSPECIFIED", "PROVIDER_SORT_FIELD_CREATED_AT", "PROVIDER_SORT_FIELD_TYPE" ] } } }, "proxies.v1.ListProvidersResponse": { "type": "object", "properties": { "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." }, "providers": { "type": "array", "description": "Full providers for this page, ordered by the requested sort. A page carries the hydrated entities, not bare ids, so the caller needs no follow-up GetProvider.", "items": { "$ref": "#/components/schemas/proxies.v1.ProxiesProvider" } } } }, "proxies.v1.ListRemediationsRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "poolId": { "type": "string", "format": "byte" }, "status": { "type": "string" } } }, "proxies.v1.ListRemediationsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "remediations": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxiesRemediation" } } } }, "proxies.v1.ListRenewalsRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "providerId": { "type": "string", "format": "byte" }, "status": { "type": "string" } } }, "proxies.v1.ListRenewalsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "renewals": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxiesRenewal" } } } }, "proxies.v1.ListSessionsRequest": { "type": "object", "properties": { "cursor": { "type": "string" }, "descending": { "type": "boolean" }, "limit": { "type": "integer", "format": "int32" }, "poolId": { "type": "string", "format": "byte" }, "sortField": { "type": "string", "enum": [ "SESSION_SORT_FIELD_UNSPECIFIED", "SESSION_SORT_FIELD_CREATED_AT", "SESSION_SORT_FIELD_HEALTH" ] } } }, "proxies.v1.ListSessionsResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "sessions": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxiesSession" } } } }, "proxies.v1.ProxiesAssignment": { "type": "object", "properties": { "accountName": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "byte" }, "pinned": { "type": "boolean" }, "poolId": { "type": "string", "format": "byte" }, "sessionId": { "type": "string", "format": "byte" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string", "format": "int64" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.ProxiesPool": { "type": "object", "properties": { "autoRotateUnhealthy": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "description": { "type": "string" }, "id": { "type": "string", "format": "byte" }, "maxAssignmentsPerSession": { "type": "integer", "format": "int32" }, "maxSessions": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "probeInterval": { "type": "string" }, "probeLatencyCeiling": { "type": "string" }, "proxyCount": { "type": "integer", "format": "int32" }, "sessionCount": { "type": "integer", "format": "int32" }, "unhealthyAfterFailures": { "type": "integer", "format": "int32" }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string", "format": "int64" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.ProxiesProvider": { "type": "object", "properties": { "capabilities": { "$ref": "#/components/schemas/proxies.v1.ProxiesProviderCapabilities" }, "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "id": { "type": "string", "format": "byte" }, "state": { "$ref": "#/components/schemas/proxies.v1.ProxiesProviderState" }, "stateRefreshedAt": { "type": "string", "format": "date-time" }, "targetPoolId": { "type": "string", "format": "byte" }, "type": { "type": "string", "enum": [ "PROVIDER_TYPE_UNSPECIFIED", "PROVIDER_TYPE_WEBSHARE_RESIDENTIAL", "PROVIDER_TYPE_WEBSHARE_STATIC", "PROVIDER_TYPE_PROXYLINE", "PROVIDER_TYPE_SUBORBITAL" ] }, "updatedAt": { "type": "string", "format": "date-time" }, "version": { "type": "string", "format": "int64" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.ProxiesProviderCapabilities": { "type": "object", "properties": { "acquirable": { "type": "boolean" }, "enumerable": { "type": "boolean" }, "releasable": { "type": "boolean" }, "renewable": { "type": "boolean" }, "replaceable": { "type": "boolean" }, "stateApi": { "type": "boolean" }, "staticExitIp": { "type": "boolean" }, "supportsSocks5": { "type": "boolean" } } }, "proxies.v1.ProxiesProviderState": { "type": "object", "properties": { "balanceCents": { "type": "string", "format": "int64" }, "bandwidthLimitBytes": { "type": "string", "format": "int64" }, "bandwidthUsedBytes": { "type": "string", "format": "int64" }, "geoCount": { "type": "integer", "format": "int32" }, "plan": { "type": "string" }, "replacementQuota": { "type": "integer", "format": "int32" } } }, "proxies.v1.ProxiesRemediation": { "type": "object", "properties": { "accountName": { "type": "string" }, "assignmentId": { "type": "string", "format": "byte" }, "attempts": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "id": { "type": "string", "format": "byte" }, "lastError": { "type": "string" }, "newSessionId": { "type": "string", "format": "byte" }, "orderReference": { "type": "string" }, "poolId": { "type": "string", "format": "byte" }, "providerId": { "type": "string", "format": "byte" }, "spendCents": { "type": "string", "format": "int64" }, "status": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.ProxiesRenewal": { "type": "object", "properties": { "attempts": { "type": "integer", "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "endpointIds": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "format": "byte" }, "lastError": { "type": "string" }, "orderReference": { "type": "string" }, "providerId": { "type": "string", "format": "byte" }, "spendCents": { "type": "string", "format": "int64" }, "status": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.ProxiesSession": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "enabled": { "type": "boolean" }, "health": { "$ref": "#/components/schemas/proxies.v1.ProxiesSessionHealth" }, "host": { "type": "string" }, "id": { "type": "string", "format": "byte" }, "poolId": { "type": "string", "format": "byte" }, "port": { "type": "integer", "format": "int32" }, "providerId": { "type": "string", "format": "byte" }, "scheme": { "type": "string" }, "slot": { "type": "integer", "format": "int32" }, "token": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "username": { "type": "string" }, "version": { "type": "string", "format": "int64" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.ProxiesSessionHealth": { "type": "object", "properties": { "consecutiveFailures": { "type": "integer", "format": "int32" }, "healthy": { "type": "boolean" }, "lastFailureAt": { "type": "string", "format": "date-time" }, "lastFailureClass": { "type": "string", "enum": [ "REQUEST_ERROR_CLASS_UNSPECIFIED", "REQUEST_ERROR_CLASS_DIAL_TIMEOUT", "REQUEST_ERROR_CLASS_DIAL_REFUSED", "REQUEST_ERROR_CLASS_AUTH_FAILED", "REQUEST_ERROR_CLASS_TLS_HANDSHAKE", "REQUEST_ERROR_CLASS_ROUNDTRIP_TIMEOUT", "REQUEST_ERROR_CLASS_UPSTREAM_5XX", "REQUEST_ERROR_CLASS_UPSTREAM_429", "REQUEST_ERROR_CLASS_BODY_READ", "REQUEST_ERROR_CLASS_CLIENT_CANCELLED" ] }, "lastFailureStatusCode": { "type": "integer", "format": "int32" }, "lastSuccessAt": { "type": "string", "format": "date-time" }, "latencyMs": { "type": "integer", "format": "int32" }, "probedAt": { "type": "string", "format": "date-time" }, "sessionId": { "type": "string", "format": "byte" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.ProxyImportRow": { "type": "object", "properties": { "host": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "scheme": { "type": "string" }, "username": { "type": "string" } } }, "proxies.v1.ProxyUsageRecord": { "type": "object", "properties": { "accountName": { "type": "string" }, "bytesIn": { "type": "string", "format": "int64" }, "bytesOut": { "type": "string", "format": "int64" }, "errorCount": { "type": "string", "format": "int64" }, "poolId": { "type": "string", "format": "byte" }, "providerId": { "type": "string", "format": "byte" }, "requestCount": { "type": "string", "format": "int64" }, "sessionId": { "type": "string", "format": "byte" }, "usageDate": { "type": "string" }, "workspaceId": { "type": "string", "format": "byte" } } }, "proxies.v1.QueryProxyUsageRequest": { "type": "object", "properties": { "accountName": { "type": "string" }, "cursor": { "type": "string" }, "endDate": { "type": "string" }, "limit": { "type": "integer", "format": "int32" }, "poolId": { "type": "string", "format": "byte" }, "providerId": { "type": "string", "format": "byte" }, "sessionId": { "type": "string", "format": "byte" }, "startDate": { "type": "string" } } }, "proxies.v1.QueryProxyUsageResponse": { "type": "object", "properties": { "nextCursor": { "type": "string" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/proxies.v1.ProxyUsageRecord" } } } }, "proxies.v1.RebindAllAssignmentsInPoolRequest": { "type": "object", "properties": { "poolId": { "type": "string", "format": "byte" } } }, "proxies.v1.RebindAllAssignmentsInPoolResponse": { "type": "object", "properties": { "assignmentIds": { "type": "array", "items": { "type": "string", "format": "byte" } } } }, "proxies.v1.RebindAssignmentRequest": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "byte" } } }, "proxies.v1.RebindAssignmentResponse": { "type": "object", "properties": { "assignment": { "$ref": "#/components/schemas/proxies.v1.ProxiesAssignment" } } }, "proxies.v1.RefreshProviderStateRequest": { "type": "object", "properties": { "providerId": { "type": "string", "format": "byte" } } }, "proxies.v1.RefreshProviderStateResponse": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/proxies.v1.ProxiesProvider" } } }, "proxies.v1.UpdateAssignmentRequest": { "type": "object", "properties": { "assignmentId": { "type": "string", "format": "byte" }, "pinned": { "type": "boolean" }, "sessionId": { "type": "string", "format": "byte" } } }, "proxies.v1.UpdateAssignmentResponse": { "type": "object", "properties": { "assignment": { "$ref": "#/components/schemas/proxies.v1.ProxiesAssignment" } } }, "proxies.v1.UpdatePoolRequest": { "type": "object", "properties": { "autoRotateUnhealthy": { "type": "boolean" }, "description": { "type": "string" }, "maxAssignmentsPerSession": { "type": "integer", "format": "int32" }, "maxSessions": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "poolId": { "type": "string", "format": "byte" }, "probeInterval": { "type": "string" }, "probeLatencyCeiling": { "type": "string" }, "unhealthyAfterFailures": { "type": "integer", "format": "int32" } } }, "proxies.v1.UpdatePoolResponse": { "type": "object", "properties": { "pool": { "$ref": "#/components/schemas/proxies.v1.ProxiesPool" } } }, "proxies.v1.UpdateProviderRequest": { "type": "object", "properties": { "credentials": { "type": "string", "format": "byte" }, "enabled": { "type": "boolean" }, "providerId": { "type": "string", "format": "byte" } } }, "proxies.v1.UpdateProviderResponse": { "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/proxies.v1.ProxiesProvider" } } }, "proxies.v1.UpdateSessionRequest": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "host": { "type": "string" }, "port": { "type": "integer", "format": "int32" }, "scheme": { "type": "string" }, "sessionId": { "type": "string", "format": "byte" }, "username": { "type": "string" } } }, "proxies.v1.UpdateSessionResponse": { "type": "object", "properties": { "session": { "$ref": "#/components/schemas/proxies.v1.ProxiesSession" } } }, "steam.v1.AcceptConfirmationRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name the confirmation belongs to.", "example": "trader_bot_01" }, "confirmationId": { "type": "string", "description": "Confirmation identifier to accept.", "example": "14258039472" } }, "required": [ "accountName", "confirmationId" ] }, "steam.v1.AcceptConfirmationResponse": { "type": "object" }, "steam.v1.AcceptTradeOfferRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account the offer was received on.", "example": "trader_bot_01" }, "offerId": { "type": "string", "description": "Trade offer identifier to accept.", "example": "6483920184" } }, "required": [ "accountName", "offerId" ] }, "steam.v1.AcceptTradeOfferResponse": { "type": "object" }, "steam.v1.Account": { "type": "object", "description": "A Steam account is a set of credentials the platform manages, including its live session status and account health flags.", "properties": { "accountName": { "type": "string", "description": "Unique Steam account name within the workspace.", "example": "trader_bot_01" }, "apiKeyConfigured": { "type": "boolean", "description": "Whether the account has its own account-tier Steam Web API key configured. Never the key itself." }, "communityBanned": { "type": "boolean", "description": "Whether the Steam account is community banned." }, "deletedAt": { "type": "string", "format": "date-time", "description": "When the account was soft deleted. Unset for an active account." }, "economyBan": { "type": "string", "description": "Steam economy ban state: none, probation, or banned.", "example": "none" }, "inventoryCheckedAt": { "type": "string", "format": "date-time", "description": "When the account's community inventory was last successfully fetched. Unset when the inventory has never been fetched." }, "inventoryPrivateSince": { "type": "string", "format": "date-time", "description": "When the account's community inventory was first observed as private. Unset when the inventory is readable." }, "lastSessionError": { "type": "string", "description": "Steam EResult name of the most recent session error. Not cleared on recovery, so it stays the last-error breadcrumb until overwritten by the next error." }, "locked": { "type": "boolean", "description": "Whether the Steam account is trade and market locked." }, "numberOfGameBans": { "type": "integer", "format": "int32", "description": "Number of game bans on the Steam account." }, "reconnectCount": { "type": "integer", "format": "int32", "description": "Number of reconnects made within the current session establishment. Resets to 0 on each new session start." }, "sessionConnectedAt": { "type": "string", "format": "date-time", "description": "When the current session last connected. Unset while disconnected." }, "sessionDisconnectedAt": { "type": "string", "format": "date-time", "description": "When the session last disconnected. Unset while connected." }, "sessionLatencyMs": { "type": "integer", "format": "int32", "description": "Most recent logon round-trip latency in milliseconds. Unset until the session's first successful logon." }, "sessionStatus": { "type": "string", "description": "Current Steam session lifecycle state.", "enum": [ "SESSION_STATUS_UNSPECIFIED", "SESSION_STATUS_DISCONNECTED", "SESSION_STATUS_CONNECTING", "SESSION_STATUS_CONNECTED", "SESSION_STATUS_LOGGED_ON", "SESSION_STATUS_ERROR" ] }, "steamId": { "type": "string", "description": "The account's 64-bit SteamID. Unset until the account has logged on at least once.", "example": "76561198000000001" }, "vacBanned": { "type": "boolean", "description": "Whether the Steam account has a VAC ban." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the account belongs to." } } }, "steam.v1.BulkCreateAccountError": { "type": "object", "description": "The failure reason for one row of a BulkCreateAccounts request that did not succeed.", "properties": { "code": { "type": "string", "description": "Machine-readable failure reason for this row.", "enum": [ "BULK_CREATE_ACCOUNT_ERROR_CODE_UNSPECIFIED", "BULK_CREATE_ACCOUNT_ERROR_CODE_ALREADY_EXISTS", "BULK_CREATE_ACCOUNT_ERROR_CODE_INVALID", "BULK_CREATE_ACCOUNT_ERROR_CODE_INTERNAL" ] }, "message": { "type": "string", "description": "Human-readable failure detail for this row." } } }, "steam.v1.BulkCreateAccountInput": { "type": "object", "description": "One account row in a BulkCreateAccounts request, with the same fields as CreateAccountRequest.", "properties": { "accountName": { "type": "string", "description": "Unique Steam account name within the workspace.", "example": "trader_bot_01" }, "identitySecret": { "type": "string", "description": "Base64 identity secret used to confirm Steam mobile trade confirmations. May be omitted, in which case the row is still accepted (see CreateAccountRequest.identity_secret for the runtime consequence)." }, "password": { "type": "string", "description": "The Steam account's login password.", "example": "hunter2pass" }, "sharedSecret": { "type": "string", "description": "Base64 shared secret used to generate the account's Steam Guard mobile authenticator codes.", "example": "sharedSecretBase64Value==" } }, "required": [ "accountName", "password", "sharedSecret" ] }, "steam.v1.BulkCreateAccountResult": { "type": "object", "description": "The outcome of one row of a BulkCreateAccounts request: the created account, or the error that row failed with.", "properties": { "account": { "description": "The created account. Unset when this row failed - see error.", "$ref": "#/components/schemas/steam.v1.Account" }, "error": { "description": "The failure reason. Unset when this row succeeded - see account.", "$ref": "#/components/schemas/steam.v1.BulkCreateAccountError" } } }, "steam.v1.BulkCreateAccountsRequest": { "type": "object", "properties": { "accounts": { "type": "array", "description": "The accounts to create. Each succeeds or fails independently.", "items": { "$ref": "#/components/schemas/steam.v1.BulkCreateAccountInput" } } } }, "steam.v1.BulkCreateAccountsResponse": { "type": "object", "properties": { "results": { "type": "array", "description": "One result per submitted row, in the same order as the request.", "items": { "$ref": "#/components/schemas/steam.v1.BulkCreateAccountResult" } } } }, "steam.v1.CancelTradeOfferRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account the offer was sent from.", "example": "trader_bot_01" }, "offerId": { "type": "string", "description": "Trade offer identifier to cancel.", "example": "6483920184" } }, "required": [ "accountName", "offerId" ] }, "steam.v1.CancelTradeOfferResponse": { "type": "object" }, "steam.v1.ChatConversation": { "type": "object", "description": "One conversation head for a Steam account's chat sidebar: the partner, the newest message, and the unread count. Carries no persona name or online state - fetch those separately with GetFriendsList or GetPersonaStates.", "properties": { "lastMessageAt": { "type": "string", "format": "date-time", "description": "When the newest message in this conversation was sent." }, "lastMessagePreview": { "type": "string", "description": "Body text of the newest message.", "example": "Hi, your item has been sent!" }, "partnerSteamId": { "type": "string", "description": "The other side of the conversation's 64-bit SteamID.", "example": "76561198044443322" }, "unreadCount": { "type": "integer", "format": "int32", "description": "Number of inbound messages newer than the account's read cursor for this conversation." } } }, "steam.v1.ChatMessage": { "type": "object", "description": "A single friend chat message sent or received by a Steam account.", "properties": { "accountName": { "type": "string", "description": "The Steam account this message belongs to." }, "body": { "type": "string", "description": "The message text.", "example": "Hi, your item has been sent!" }, "createdAt": { "type": "string", "format": "date-time", "description": "When this record was stored by the platform." }, "direction": { "type": "string", "description": "Whether the account sent or received this message.", "enum": [ "CHAT_MESSAGE_DIRECTION_UNSPECIFIED", "CHAT_MESSAGE_DIRECTION_INBOUND", "CHAT_MESSAGE_DIRECTION_OUTBOUND" ] }, "id": { "type": "string", "format": "int64", "description": "Chat message identifier.", "example": "81923" }, "ordinal": { "type": "integer", "format": "int32", "description": "Steam's per-conversation, per-second tiebreaker for messages sharing the same sent_at." }, "partnerSteamId": { "type": "string", "description": "The 64-bit SteamID of the other side of the conversation.", "example": "76561198044443322" }, "sentAt": { "type": "string", "format": "date-time", "description": "Steam's own server timestamp for when the message was sent." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the message belongs to." } } }, "steam.v1.Confirmation": { "type": "object", "description": "A single Steam mobile confirmation in an account's confirmation queue, such as a give-side trade accept or a Community Market listing.", "properties": { "accountName": { "type": "string", "description": "The Steam account this confirmation belongs to." }, "confirmationId": { "type": "string", "description": "Confirmation identifier.", "example": "14258039472" }, "createdAt": { "type": "string", "format": "date-time", "description": "When this confirmation was first observed." }, "creatorId": { "type": "string", "description": "The trade offer id or market listing id this confirmation is for.", "example": "6483920185" }, "resolvedAt": { "type": "string", "format": "date-time", "description": "When this confirmation was accepted, declined, or observed as vanished from the list. Unset while pending." }, "status": { "type": "string", "description": "Current lifecycle state of the confirmation.", "enum": [ "CONFIRMATION_STATUS_UNSPECIFIED", "CONFIRMATION_STATUS_PENDING", "CONFIRMATION_STATUS_ACCEPTED", "CONFIRMATION_STATUS_DECLINED", "CONFIRMATION_STATUS_GONE" ] }, "type": { "type": "string", "description": "Steam confirmation type as lowercase snake_case text, for example trade or market_listing.", "example": "trade" }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the confirmation belongs to." } } }, "steam.v1.ConversationAccountReference": { "type": "object", "description": "One Steam account's own thread with a WorkspaceConversation counterpart: the account, its own newest-message timestamp, and its own unread count.", "properties": { "accountName": { "type": "string", "description": "Steam account name holding this thread." }, "lastMessageAt": { "type": "string", "format": "date-time", "description": "When this account's newest message with the counterpart was sent." }, "unreadCount": { "type": "integer", "format": "int32", "description": "Number of unread inbound messages on this account's thread with the counterpart." } } }, "steam.v1.CreateAccountRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Unique Steam account name within the workspace.", "example": "trader_bot_01" }, "identitySecret": { "type": "string", "description": "Base64 identity secret used to confirm Steam mobile trade confirmations. May be omitted for an account imported without one; its session still logs on, but it cannot confirm outbound trade offers until a real identity secret is set.", "example": "identitySecretBase64Value==" }, "password": { "type": "string", "description": "The Steam account's login password.", "example": "hunter2pass" }, "sharedSecret": { "type": "string", "description": "Base64 shared secret used to generate the account's Steam Guard mobile authenticator codes.", "example": "sharedSecretBase64Value==" } }, "required": [ "accountName", "password", "sharedSecret" ] }, "steam.v1.CreateAccountResponse": { "type": "object", "properties": { "account": { "description": "The created Steam account.", "$ref": "#/components/schemas/steam.v1.Account" } } }, "steam.v1.DeclineConfirmationRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name the confirmation belongs to.", "example": "trader_bot_01" }, "confirmationId": { "type": "string", "description": "Confirmation identifier to decline.", "example": "14258039472" } }, "required": [ "accountName", "confirmationId" ] }, "steam.v1.DeclineConfirmationResponse": { "type": "object" }, "steam.v1.DeclineTradeOfferRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account the offer was received on.", "example": "trader_bot_01" }, "offerId": { "type": "string", "description": "Trade offer identifier to decline.", "example": "6483920184" } }, "required": [ "accountName", "offerId" ] }, "steam.v1.DeclineTradeOfferResponse": { "type": "object" }, "steam.v1.DeleteAccountRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name to delete.", "example": "trader_bot_01" } }, "required": [ "accountName" ] }, "steam.v1.DeleteAccountResponse": { "type": "object" }, "steam.v1.Friend": { "type": "object", "description": "One entry in a Steam account's friends list.", "properties": { "relationship": { "type": "integer", "format": "int32", "description": "Raw Steam EFriendRelationship value. Callers distinguish pending invitations from established friends based on this value." }, "steamId": { "type": "string", "format": "int64", "description": "The friend's 64-bit SteamID.", "example": "76561198044443322" } } }, "steam.v1.FriendsList": { "type": "object", "description": "The full snapshot of a Steam account's friends, as observed by its live session cache.", "properties": { "accountName": { "type": "string", "description": "The Steam account this friends list belongs to." }, "friends": { "type": "array", "description": "Every friend and pending invitation currently observed for the account.", "items": { "$ref": "#/components/schemas/steam.v1.Friend" } }, "observedAt": { "type": "string", "format": "date-time", "description": "When this snapshot was last observed from Steam." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the account belongs to." } } }, "steam.v1.GetAccountRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name to look up.", "example": "trader_bot_01" } }, "required": [ "accountName" ] }, "steam.v1.GetAccountResponse": { "type": "object", "properties": { "account": { "description": "The requested Steam account.", "$ref": "#/components/schemas/steam.v1.Account" } } }, "steam.v1.GetAccountsRequest": { "type": "object", "properties": { "accountNames": { "type": "array", "description": "Steam account names to look up.", "items": { "type": "string" } } } }, "steam.v1.GetAccountsResponse": { "type": "object", "properties": { "accounts": { "type": "array", "description": "The accounts that were found.", "items": { "$ref": "#/components/schemas/steam.v1.Account" } }, "notFoundAccountNames": { "type": "array", "description": "Requested account names that do not exist in the workspace.", "items": { "type": "string" } } } }, "steam.v1.GetFriendsListRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name whose friends list to read.", "example": "trader_bot_01" } }, "required": [ "accountName" ] }, "steam.v1.GetFriendsListResponse": { "type": "object", "properties": { "friendsList": { "description": "The account's current friends-list snapshot.", "$ref": "#/components/schemas/steam.v1.FriendsList" } } }, "steam.v1.GetInventoryRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name whose inventory to read.", "example": "trader_bot_01" }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous GetInventoryResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of items to return. Server caps this at a service-defined upper bound.", "example": 50 } }, "required": [ "accountName" ] }, "steam.v1.GetInventoryResponse": { "type": "object", "properties": { "fetchedAt": { "type": "string", "format": "date-time", "description": "When the returned inventory snapshot was fetched from Steam." }, "items": { "type": "array", "description": "Full items for this page.", "items": { "$ref": "#/components/schemas/steam.v1.InventoryItem" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "steam.v1.GetPersonaStatesRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account whose session cache to read.", "example": "trader_bot_01" }, "steamIds": { "type": "array", "description": "SteamIDs to look up. An id the worker has not yet observed is forwarded to Steam and omitted from the response until it is cached.", "items": { "type": "string", "format": "int64" } } }, "required": [ "accountName" ] }, "steam.v1.GetPersonaStatesResponse": { "type": "object", "properties": { "personas": { "type": "array", "description": "Cached persona snapshots for the subset of requested SteamIDs already observed.", "items": { "$ref": "#/components/schemas/steam.v1.Persona" } } } }, "steam.v1.GetWorkspaceAPIKeyRequest": { "type": "object" }, "steam.v1.GetWorkspaceAPIKeyResponse": { "type": "object", "properties": { "configured": { "type": "boolean", "description": "Whether the workspace has a workspace-tier Steam Web API key configured." }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the key was last set. Unset when configured is false." }, "updatedBy": { "type": "string", "format": "byte", "description": "The member who last set the key. Unset when configured is false." } } }, "steam.v1.InventoryItem": { "type": "object", "description": "A single item observed in a Steam account's community inventory.", "properties": { "accountName": { "type": "string", "description": "The Steam account holding this item. Empty on the GetInventory response, where the caller already knows which account it queried." }, "amount": { "type": "string", "format": "int64", "description": "Stack size for a stackable item; 1 for a non-stackable item." }, "appId": { "type": "integer", "format": "int32", "description": "Steam app id the item belongs to.", "example": 730 }, "assetId": { "type": "string", "description": "The item's Steam asset id, unique within the account's inventory.", "example": "31795888228" }, "classId": { "type": "string", "description": "Steam class id identifying the item's definition.", "example": "310776898" }, "contextId": { "type": "string", "description": "Steam inventory context id the item belongs to.", "example": "2" }, "iconUrl": { "type": "string", "description": "The item's Valve-hosted economy icon hash for this exact instance. Empty when the item carries no per-instance render." }, "instanceId": { "type": "string", "description": "Steam instance id, distinguishing item instances that share a class id.", "example": "302028390" }, "marketHashName": { "type": "string", "description": "The item's market hash name.", "example": "AK-47 | Redline (Field-Tested)" }, "tradable": { "type": "boolean", "description": "Whether the item is currently tradable." }, "tradableAfter": { "type": "string", "format": "date-time", "description": "When a held item becomes tradable. Unset when the item carries no trade hold." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the item belongs to. Zero on the GetInventory response, where the caller already knows which account it queried." } } }, "steam.v1.ListAccountsRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListAccountsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of accounts to return. Server caps this at a service-defined upper bound.", "example": 50 } } }, "steam.v1.ListAccountsResponse": { "type": "object", "properties": { "accounts": { "type": "array", "description": "Full accounts for this page. A page carries the hydrated entities, not bare names, so the caller needs no follow-up GetAccounts.", "items": { "$ref": "#/components/schemas/steam.v1.Account" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "steam.v1.ListChatConversationsRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name whose conversations to list.", "example": "trader_bot_01" }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListChatConversationsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of conversations to return. Server caps this at a service-defined upper bound.", "example": 50 } }, "required": [ "accountName" ] }, "steam.v1.ListChatConversationsResponse": { "type": "object", "properties": { "conversations": { "type": "array", "description": "Conversation heads, newest message first.", "items": { "$ref": "#/components/schemas/steam.v1.ChatConversation" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "steam.v1.ListChatMessagesRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name whose conversation to read.", "example": "trader_bot_01" }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListChatMessagesResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of messages to return. Server caps this at a service-defined upper bound.", "example": 50 }, "partnerSteamId": { "type": "string", "description": "The other side of the conversation's 64-bit SteamID.", "example": "76561198044443322" } }, "required": [ "accountName", "partnerSteamId" ] }, "steam.v1.ListChatMessagesResponse": { "type": "object", "properties": { "messages": { "type": "array", "description": "Messages in the conversation, newest first.", "items": { "$ref": "#/components/schemas/steam.v1.ChatMessage" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "steam.v1.ListConfirmationsRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name whose confirmation queue to list.", "example": "trader_bot_01" }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListConfirmationsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of confirmations to return. Server caps this at a service-defined upper bound.", "example": 50 }, "status": { "type": "string", "description": "Optional filter: return only confirmations in this status. Omitted, or CONFIRMATION_STATUS_UNSPECIFIED, returns every status.", "enum": [ "CONFIRMATION_STATUS_UNSPECIFIED", "CONFIRMATION_STATUS_PENDING", "CONFIRMATION_STATUS_ACCEPTED", "CONFIRMATION_STATUS_DECLINED", "CONFIRMATION_STATUS_GONE" ] } }, "required": [ "accountName" ] }, "steam.v1.ListConfirmationsResponse": { "type": "object", "properties": { "confirmations": { "type": "array", "description": "Full confirmations for this page.", "items": { "$ref": "#/components/schemas/steam.v1.Confirmation" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "steam.v1.ListTradeOffersRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Optional filter: return only this account's trade offers. Empty lists every account's trade offers in the workspace." }, "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListTradeOffersResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of trade offers to return. Server caps this at a service-defined upper bound.", "example": 50 }, "state": { "type": "string", "description": "Optional filter: return only offers in this Steam ETradeOfferState, as its stored lowercase text. Omitted returns all states.", "example": "active" } } }, "steam.v1.ListTradeOffersResponse": { "type": "object", "properties": { "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." }, "tradeOffers": { "type": "array", "description": "Full trade offers for this page, newest first.", "items": { "$ref": "#/components/schemas/steam.v1.TradeOffer" } } } }, "steam.v1.ListWorkspaceConversationsRequest": { "type": "object", "properties": { "cursor": { "type": "string", "description": "Opaque pagination cursor from a previous ListWorkspaceConversationsResponse. Empty for the first page." }, "limit": { "type": "integer", "format": "int32", "description": "Maximum number of conversations to return. Server caps this at a service-defined upper bound.", "example": 50 } } }, "steam.v1.ListWorkspaceConversationsResponse": { "type": "object", "properties": { "conversations": { "type": "array", "description": "Aggregated conversations, newest message first.", "items": { "$ref": "#/components/schemas/steam.v1.WorkspaceConversation" } }, "nextCursor": { "type": "string", "description": "Cursor to pass to fetch the next page. Empty when there are no more results." } } }, "steam.v1.MarkChatReadRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name whose read cursor to update.", "example": "trader_bot_01" }, "lastReadAt": { "type": "string", "format": "date-time", "description": "Move the read cursor up to this timestamp. Must be monotonically increasing; a call that would move it backward leaves the cursor unchanged." }, "partnerSteamId": { "type": "string", "description": "The other side of the conversation's 64-bit SteamID.", "example": "76561198044443322" } }, "required": [ "accountName", "lastReadAt", "partnerSteamId" ] }, "steam.v1.MarkChatReadResponse": { "type": "object" }, "steam.v1.Persona": { "type": "object", "description": "A cached snapshot of a Steam user's persona state - display name, online state, and current game.", "properties": { "avatarHash": { "type": "string", "format": "byte", "description": "The user's raw Steam avatar hash. Used to derive the avatar image URL; empty falls back to an initials placeholder." }, "gameId": { "type": "string", "format": "int64", "description": "App id of the game the user is currently playing. Zero when not in a game." }, "gameName": { "type": "string", "description": "Name of the game the user is currently playing. Empty when not in a game.", "example": "Counter-Strike 2" }, "observedAt": { "type": "string", "format": "date-time", "description": "When this persona snapshot was last observed from Steam." }, "playerName": { "type": "string", "description": "The user's current Steam display name.", "example": "BuyerOne" }, "state": { "type": "integer", "format": "int32", "description": "Raw Steam EPersonaState value for the user's online status." }, "steamId": { "type": "string", "format": "int64", "description": "The user's 64-bit SteamID.", "example": "76561198044443322" } } }, "steam.v1.SendChatMessageRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Sending Steam account name.", "example": "trader_bot_01" }, "body": { "type": "string", "description": "The message text. Capped at Steam's 1024-character message limit and subject to a 200-message/24h rate cap per account.", "example": "Hi, your item has been sent!" }, "partnerSteamId": { "type": "string", "description": "The recipient's 64-bit SteamID.", "example": "76561198044443322" } }, "required": [ "accountName", "body", "partnerSteamId" ] }, "steam.v1.SendChatMessageResponse": { "type": "object" }, "steam.v1.SendTradeOfferRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "The sending Steam account - the seller delivering the item.", "example": "trader_bot_01" }, "itemsToGive": { "type": "array", "description": "Assets the sending account offers.", "items": { "$ref": "#/components/schemas/steam.v1.TradeItem" } }, "itemsToReceive": { "type": "array", "description": "Assets the sending account requests in return. Empty for a marketplace sale delivery; carried for a general two-sided send.", "items": { "$ref": "#/components/schemas/steam.v1.TradeItem" } }, "message": { "type": "string", "description": "Optional message attached to the offer.", "example": "Delivery for your purchase" }, "partnerSteamId": { "type": "string", "description": "The recipient's 64-bit SteamID.", "example": "76561198044443322" }, "tradeToken": { "type": "string", "description": "The recipient's trade-URL token, required to send to a non-friend. Unrelated to Steam authentication access tokens.", "example": "aBcD1234" } }, "required": [ "accountName", "partnerSteamId", "tradeToken" ] }, "steam.v1.SendTradeOfferResponse": { "type": "object" }, "steam.v1.SetWorkspaceAPIKeyRequest": { "type": "object", "properties": { "apiKey": { "type": "string", "description": "The workspace-tier Steam Web API key. Upserts in place, so a repeat call rotates the key.", "example": "1A2B3C4D5E6F7890ABCDEF1234567890" } }, "required": [ "apiKey" ] }, "steam.v1.SetWorkspaceAPIKeyResponse": { "type": "object" }, "steam.v1.TradeCompletion": { "type": "object", "description": "The result of a completed trade: the trade id and the per-side asset id mappings from before to after the trade.", "properties": { "assetsGiven": { "type": "array", "description": "Assets this account gave, with their before and after identities.", "items": { "$ref": "#/components/schemas/steam.v1.TradeCompletionAsset" } }, "assetsReceived": { "type": "array", "description": "Assets this account received, with their before and after identities.", "items": { "$ref": "#/components/schemas/steam.v1.TradeCompletionAsset" } }, "completedAt": { "type": "string", "format": "date-time", "description": "When the trade completed." }, "tradeId": { "type": "string", "description": "Steam's trade id, distinct from the trade offer id." } } }, "steam.v1.TradeCompletionAsset": { "type": "object", "description": "One asset's identity before and after a completed trade.", "properties": { "amount": { "type": "string", "description": "Stack size for a stackable asset; 1 for a non-stackable asset." }, "appId": { "type": "integer", "format": "int32", "description": "Steam app id the asset belongs to." }, "classId": { "type": "string", "description": "Steam class id identifying the asset's definition." }, "contextId": { "type": "string", "description": "Steam inventory context id the asset belongs to." }, "instanceId": { "type": "string", "description": "Steam instance id, distinguishing asset instances that share a class id." }, "newAssetId": { "type": "string", "description": "The asset id Steam assigned after the trade completed." }, "oldAssetId": { "type": "string", "description": "The asset id before the trade completed." } } }, "steam.v1.TradeItem": { "type": "object", "description": "A single Steam item offered or received in a trade offer.", "properties": { "amount": { "type": "string", "format": "int64", "description": "Stack size for a stackable item; 1 for a non-stackable item." }, "appId": { "type": "integer", "format": "int32", "description": "Steam app id the item belongs to.", "example": 730 }, "assetId": { "type": "string", "description": "The item's Steam asset id.", "example": "31795888228" }, "classId": { "type": "string", "description": "Steam class id identifying the item's definition.", "example": "310776898" }, "contextId": { "type": "string", "description": "Steam inventory context id the item belongs to.", "example": "2" }, "instanceId": { "type": "string", "description": "Steam instance id, distinguishing item instances that share a class id.", "example": "302028390" }, "marketHashName": { "type": "string", "description": "The item's market hash name.", "example": "AK-47 | Redline (Field-Tested)" } } }, "steam.v1.TradeOffer": { "type": "object", "description": "A Steam trade offer sent or received by a Steam account, mirrored from Steam's trade-offer poll.", "properties": { "accountName": { "type": "string", "description": "The Steam account this offer belongs to." }, "createdAt": { "type": "string", "format": "date-time", "description": "When the offer was created on Steam." }, "direction": { "type": "string", "description": "Whether this account sent or received the offer. Determines which action RPCs apply: a sent offer only accepts CancelTradeOffer, a received offer accepts AcceptTradeOffer or DeclineTradeOffer.", "enum": [ "TRADE_OFFER_DIRECTION_UNSPECIFIED", "TRADE_OFFER_DIRECTION_SENT", "TRADE_OFFER_DIRECTION_RECEIVED" ] }, "escrowEndDate": { "type": "string", "format": "date-time", "description": "When an escrow hold on this offer auto-executes. Unset when the offer is not held or Steam has not yet published the date." }, "expiresAt": { "type": "string", "format": "date-time", "description": "When the offer expires on Steam." }, "itemsToGive": { "type": "array", "description": "Items the account is offering.", "items": { "$ref": "#/components/schemas/steam.v1.TradeItem" } }, "itemsToReceive": { "type": "array", "description": "Items the account is receiving.", "items": { "$ref": "#/components/schemas/steam.v1.TradeItem" } }, "message": { "type": "string", "description": "The offer's accompanying message.", "example": "Thanks for the trade" }, "offerId": { "type": "string", "description": "The trade offer's Steam id.", "example": "6483920184" }, "partnerSteamId": { "type": "string", "description": "The other side of the trade's 64-bit SteamID.", "example": "76561198044443322" }, "settlementDate": { "type": "string", "format": "date-time", "description": "When the trade is no longer reversible. Unset when Steam returns no settlement date." }, "state": { "type": "string", "description": "Steam ETradeOfferState as its stored lowercase text.", "example": "active" }, "tradeCompletion": { "description": "The completed trade's asset id mappings. Unset until Steam reports the trade complete; offers this account sent never carry a completion.", "$ref": "#/components/schemas/steam.v1.TradeCompletion" }, "updatedAt": { "type": "string", "format": "date-time", "description": "When the offer was last observed to change." }, "workspaceId": { "type": "string", "format": "byte", "description": "Workspace the offer belongs to." } } }, "steam.v1.UpdateAccountRequest": { "type": "object", "properties": { "accountName": { "type": "string", "description": "Steam account name to update.", "example": "trader_bot_01" }, "apiKey": { "type": "string", "description": "New account-tier Steam Web API key. Omit to leave unchanged." }, "identitySecret": { "type": "string", "description": "New mobile confirmation identity secret, base64 encoded. Omit to leave unchanged." }, "password": { "type": "string", "description": "New login password. Omit to leave unchanged.", "example": "newpassword99" }, "sharedSecret": { "type": "string", "description": "New Steam Guard mobile authenticator shared secret, base64 encoded. Omit to leave unchanged." } }, "required": [ "accountName" ] }, "steam.v1.UpdateAccountResponse": { "type": "object", "properties": { "account": { "description": "The updated Steam account.", "$ref": "#/components/schemas/steam.v1.Account" } } }, "steam.v1.WorkspaceConversation": { "type": "object", "description": "One counterpart's aggregated conversation across every Steam account in the workspace that holds a thread with them.", "properties": { "accounts": { "type": "array", "description": "Every workspace account holding a thread with this counterpart, most recently active first.", "items": { "$ref": "#/components/schemas/steam.v1.ConversationAccountReference" } }, "lastMessageAt": { "type": "string", "format": "date-time", "description": "When the newest message across every account's thread with this counterpart was sent." }, "lastMessagePreview": { "type": "string", "description": "Body text of the newest message across every account's thread with this counterpart.", "example": "Hi, your item has been sent!" }, "partnerSteamId": { "type": "string", "description": "The counterpart's 64-bit SteamID.", "example": "76561198044443322" }, "unreadCount": { "type": "integer", "format": "int32", "description": "Unread message count summed across every account's thread with this counterpart." } } } } } }