SteamMarketRunner API (0.1.0)

Download OpenAPI specification:Download

Operational backend for SteamMarketRunner trading automation.

notifications

NotificationSettingsController_get

Responses

Response samples

200

Content type

application/json

{"enabled": true,
"minSeverity": "info",
"telegramChatId": "string",
"hasWebhook": true
}

NotificationSettingsController_update

Responses

Response samples

200

Content type

application/json

{"enabled": true,
"minSeverity": "info",
"telegramChatId": "string",
"hasWebhook": true
}

NotificationFeedController_feed

query Parameters

limit

required

string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": { },
"appid": 252490,
"category": "runner.started",
"severity": "debug",
"message": "Trading started",
"actorType": "service_api",
"actorName": "openclaw",
"requestId": "frontend-request-1",
"data": { },
"createdAt": "2019-08-24T14:15:22Z"
}
]

NotificationFeedController_activity

query Parameters

limit

required

string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": { },
"appid": 252490,
"category": "runner.started",
"severity": "debug",
"message": "Trading started",
"actorType": "service_api",
"actorName": "openclaw",
"requestId": "frontend-request-1",
"data": { },
"createdAt": "2019-08-24T14:15:22Z"
}
]

UserAuditController_list

query Parameters

limit required	string
offset required	string
steamAccountId required	string
category required	string
severity required	string
since required	string
search required	string
includeTechnical required	string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": { },
"appid": 252490,
"category": "runner.started",
"severity": "debug",
"message": "Trading started",
"actorType": "service_api",
"actorName": "openclaw",
"requestId": "frontend-request-1",
"data": { },
"createdAt": "2019-08-24T14:15:22Z"
}
]

announcements

AnnouncementsController_active

Responses

Response samples

200

Content type

application/json

{"items": [{"id": "string",
"severity": "info",
"title": "string",
"body": "string",
"publishAt": "string",
"expiresAt": "string",
"dismissible": true,
"actionUrl": "string",
"dismissedAt": "string"
}
],
"serverTime": "string"
}

AnnouncementsController_dismiss

path Parameters

id

required

string

Responses

currency

CurrencyRatesController_get

Responses

Response samples

200

Content type

application/json

{"rates": {"USD": 1,
"RUB": 90
},
"fetchedAt": "string"
}

preferences

PreferencesController_get

Responses

Response samples

200

Content type

application/json

{"displayCurrency": "USD"
}

PreferencesController_update

Responses

Response samples

200

Content type

application/json

{"displayCurrency": "USD"
}

auth

AuthController_startGoogleOAuth

Responses

AuthController_completeGoogleOAuth

Responses

AuthController_signup

Request Body schema: application/json
required

email required	string
password required	string >= 12 characters

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]",
"password": "aStrongPassphrase"
}

Response samples

201

Content type

application/json

{"status": "verification_required",
"email": "[email protected]"
}

AuthController_resendEmailVerification

Request Body schema: application/json
required

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]"
}

Response samples

201

Content type

application/json

{"ok": true
}

AuthController_confirmEmailVerification

Request Body schema: application/json
required

token

required

string

Responses

Request samples

Payload

Content type

application/json

{"token": "opaque-token-string"
}

Response samples

201

Content type

application/json

{"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "admin",
"emailVerified": true,
"emailVerifiedAt": { }
}
}

AuthController_login

Request Body schema: application/json
required

email required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"email": "admin",
"password": "admin"
}

Response samples

201

Content type

application/json

{"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "admin",
"emailVerified": true,
"emailVerifiedAt": { }
}
}

AuthController_requestPasswordReset

Request Body schema: application/json
required

email

required

string

Responses

Request samples

Payload

Content type

application/json

{"email": "[email protected]"
}

Response samples

201

Content type

application/json

{"ok": true,
"token": "string",
"expiresAt": { }
}

AuthController_confirmPasswordReset

Request Body schema: application/json
required

token required	string
password required	string >= 12 characters

Responses

Request samples

Payload

Content type

application/json

{"token": "opaque-token-string",
"password": "aNewStrongPassphrase"
}

Response samples

201

Content type

application/json

{"ok": true
}

AuthController_me

Responses

Response samples

200

Content type

application/json

{"user": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"email": "admin",
"emailVerified": true,
"emailVerifiedAt": { }
}
}

AuthController_logout

Responses

Response samples

201

Content type

application/json

{"ok": true
}

AuthController_getServiceAuth

Responses

Response samples

200

Content type

application/json

{"actor": {"type": "service_api",
"name": "openclaw"
},
"requestId": "openclaw-probe-1",
"capabilities": {"auth": {"actorHeader": "x-steammarketrunner-actor",
"requestIdHeader": "x-request-id"
},
"idempotency": {"header": "x-idempotency-key",
"decisionEnqueue": true,
"runnerStaleJobRecovery": true,
"runnerFailedJobRequeue": true
},
"audit": {"actorAttribution": true
}
}
}

AuthController_listServiceApiKeys

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "OpenClaw",
"prefix": "mops_abc",
"lastFour": "wxyz",
"createdAt": { },
"updatedAt": { },
"lastUsedAt": { },
"revokedAt": { }
}
]

AuthController_createServiceApiKey

Request Body schema: application/json
required

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "OpenClaw"
}

Response samples

201

Content type

application/json

{"key": "mops_plaintext_key",
"serviceKey": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "OpenClaw",
"prefix": "mops_abc",
"lastFour": "wxyz",
"createdAt": { },
"updatedAt": { },
"lastUsedAt": { },
"revokedAt": { }
}
}

AuthController_revokeServiceApiKey

path Parameters

id

required

string

Responses

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "OpenClaw",
"prefix": "mops_abc",
"lastFour": "wxyz",
"createdAt": { },
"updatedAt": { },
"lastUsedAt": { },
"revokedAt": { }
}

health

HealthController_getHealth

Responses

Response samples

200

Content type

application/json

{"ok": true,
"service": "steammarketrunner-api"
}

HealthController_getReadiness

Responses

Response samples

200
503

Content type

application/json

{"ok": true,
"service": "steammarketrunner-api",
"status": "ready",
"signal": "SIGTERM",
"dependencies": {"database": {"ok": true,
"latencyMs": 2
},
"redis": {"ok": true,
"latencyMs": 2
}
}
}

MetaController_getErrorCodes

Responses

Response samples

200

Content type

application/json

{"errorCodes": [{"code": "VALIDATION_FAILED",
"statusCode": 400,
"retryable": false
}
]
}

MetaController_getCapabilities

Responses

Response samples

200

Content type

application/json

{"headers": {"apiKey": "x-api-key",
"actor": "x-steammarketrunner-actor",
"requestId": "x-request-id",
"idempotencyKey": "x-idempotency-key"
},
"idempotency": {"requiredFor": ["string"
]
},
"endpoints": {"read": ["string"
],
"mutate": ["string"
],
"dangerous": ["string"
]
}
}

MetaController_getLimits

Responses

Response samples

200

Content type

application/json

{"maxCandidatesPerJob": 100,
"minRequestDelayMs": 0
}

MetaController_getVersion

Responses

Response samples

200

Content type

application/json

{"service": "steammarketrunner-api",
"version": "0.0.1",
"build": {"sha": "abc1234",
"time": "2026-05-26T10:00:00.000Z"
}
}

games

GameCatalogController_list

Responses

Response samples

200

Content type

application/json

[{"appid": 252490,
"name": "Rust",
"defaultContextid": "2",
"moduleKey": "rust",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

steam-accounts

AccountsController_create

Request Body schema: application/json
required

displayName required	string
steamId	string
setupBootstrapAppids	Array of numbers Steam game appids to import/sync during safe setup bootstrap
	object (UpsertSteamAccountSecretsDto)
	object (UpsertProxyProfileDto)

Responses

Request samples

Payload

Content type

application/json

{"displayName": "Main Steam",
"steamId": "76561198000000000",
"setupBootstrapAppids": [730,
252490
],
"secrets": {"login": "steam-login",
"password": "steam-password",
"maFile": { }
},
"proxy": {"protocol": "http",
"host": "127.0.0.1",
"port": 8080,
"username": "proxy-user",
"password": "proxy-password",
"expectedIp": "203.0.113.10"
}
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft",
"sessionState": { },
"walletBalance": "10000",
"walletDelayedBalance": "82",
"setupBootstrapAppids": [730,
252490
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

AccountsController_list

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft",
"sessionState": { },
"walletBalance": "10000",
"walletDelayedBalance": "82",
"setupBootstrapAppids": [730,
252490
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

AccountsController_get

path Parameters

steamAccountId

required

string

Responses

AccountsController_update

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

displayName	string
steamId	object or null
status	string Enum: "draft" "ready" "blocked" "disabled"

Responses

Request samples

Payload

Content type

application/json

{"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft",
"sessionState": { },
"walletBalance": "10000",
"walletDelayedBalance": "82",
"setupBootstrapAppids": [730,
252490
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

AccountsController_delete

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft",
"sessionState": { },
"walletBalance": "10000",
"walletDelayedBalance": "82",
"setupBootstrapAppids": [730,
252490
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

AccountsController_setupBootstrap

path Parameters

steamAccountId

required

string

Responses

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"type": "account_setup_bootstrap",
"jobQueueId": "4e8df10a-ec05-4672-82ee-3a1100dc2c76",
"bullJobId": "bull-job-1",
"status": "queued"
}

AccountsController_upsertSecrets

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

login	string
password	string
	object

Responses

Request samples

Payload

Content type

application/json

{"login": "steam-login",
"password": "steam-password",
"maFile": { }
}

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"hasLogin": true,
"hasPassword": true,
"hasMaFile": false,
"updatedAt": "2019-08-24T14:15:22Z"
}

AccountsController_getSecretsStatus

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"hasLogin": true,
"hasPassword": true,
"hasMaFile": false,
"updatedAt": "2019-08-24T14:15:22Z"
}

AccountsController_listAuditEvents

path Parameters

steamAccountId

required

string

Responses

proxy

ProxyController_getProxy

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"protocol": "http",
"host": "127.0.0.1",
"port": 8080,
"expectedIp": "203.0.113.10",
"lastStatus": "unknown",
"lastLatencyMs": 123,
"hasUsername": true,
"hasPassword": true,
"updatedAt": "2019-08-24T14:15:22Z"
}

ProxyController_upsertProxy

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

protocol required	string Enum: "http" "https" "socks4" "socks5"
host required	string
port required	number [ 1 .. 65535 ]
username	string
password	string
expectedIp	object or null

Responses

Request samples

Payload

Content type

application/json

{"protocol": "http",
"host": "127.0.0.1",
"port": 8080,
"username": "proxy-user",
"password": "proxy-password",
"expectedIp": "203.0.113.10"
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"protocol": "http",
"host": "127.0.0.1",
"port": 8080,
"expectedIp": "203.0.113.10",
"lastStatus": "unknown",
"lastLatencyMs": 123,
"hasUsername": true,
"hasPassword": true,
"updatedAt": "2019-08-24T14:15:22Z"
}

ProxyController_testProxy

path Parameters

steamAccountId

required

string

Responses

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"status": "missing_proxy",
"statusCode": 200,
"expectedIp": "203.0.113.10",
"observedIp": "203.0.113.10",
"latencyMs": 123,
"proxyUsed": true,
"message": "Proxy test succeeded."
}

market-state

MarketStateController_createItem

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

appid required	number
contextid required	string
marketHashName required	string
itemNameid	string
displayName	string
	object
	object
	object (TradeStateDto)

Responses

Request samples

Payload

Content type

application/json

{"appid": 252490,
"contextid": "2",
"marketHashName": "Metal Facemask",
"itemNameid": "string",
"displayName": "string",
"gameMetadata": { },
"legacyState": { },
"tradeState": {"buyEnabled": false,
"sellEnabled": false,
"buyPrice": 1000,
"sellNetPrice": 1200,
"sellGrossPrice": 1400,
"currency": "USD",
"buyQuantity": 1,
"activeBuyOrderId": { },
"activeBuyOrderCount": 0,
"activeListingCount": 0,
"inventoryCount": 1
}
}

Response samples

201

Content type

application/json

{"item": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"catalogItemId": "29b1d1d1-e291-455b-a461-73ea206c4445",
"groupId": { },
"appid": 252490,
"contextid": "2",
"marketHashName": "Metal Facemask",
"itemNameid": { },
"displayName": { },
"gameMetadata": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"tradeState": {"buyEnabled": false,
"sellEnabled": false,
"buyPrice": 1000,
"sellNetPrice": 1200,
"sellGrossPrice": 1400,
"currency": "USD",
"buyQuantity": 1,
"activeBuyOrderId": { },
"activeBuyOrderCount": 0,
"activeListingCount": 0,
"inventoryCount": 1,
"marketItemId": "c22ca94e-d32e-4075-bcba-f188e21855ae",
"legacyState": { },
"updatedAt": "2019-08-24T14:15:22Z"
}
}

MarketStateController_listItems

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"catalogItemId": "29b1d1d1-e291-455b-a461-73ea206c4445",
"groupId": { },
"appid": 252490,
"contextid": "2",
"marketHashName": "Metal Facemask",
"itemNameid": { },
"displayName": { },
"gameMetadata": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"page": 1,
"pageSize": 100,
"pageCount": 18,
"total": 1793
}

MarketStateController_getPortfolio

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"items": [{"marketItemId": "c22ca94e-d32e-4075-bcba-f188e21855ae",
"marketHashName": "Wall Divider Pack",
"appid": 252490,
"contextid": "2",
"inventory": {"total": 3,
"available": 2,
"held": 1,
"holdBreakdown": [{ }
],
"nextUnlockAt": "2019-08-24T14:15:22Z",
"assets": [{"assetId": "1234567890",
"unitIndex": 1,
"marketable": true,
"holdUntil": "2019-08-24T14:15:22Z",
"purchasePrice": 125,
"purchaseAt": "2019-08-24T14:15:22Z"
}
],
"purchaseUnits": [{"unitPrice": 125,
"occurredAt": "2019-08-24T14:15:22Z",
"currency": "USD"
}
]
},
"listing": {"count": 1,
"price": 124,
"value": 124
},
"buyOrder": {"count": 1,
"quantity": 5,
"price": 76,
"exposure": 380,
"orderDate": "2019-08-24T14:15:22Z"
},
"orderDepth": {"topBuyPrice": 80,
"centsBehindTop": 4,
"pctOfTopBuy": 95,
"quantityAhead": 37,
"estimatedQueuePosition": 38,
"checkedAt": "2019-08-24T14:15:22Z",
"stale": false
},
"valuation": {"currency": "USD",
"unitPrice": 120,
"inventoryValue": 360,
"onSaleValue": 124,
"onOrdersValueExcluded": 380
}
}
],
"total": 10,
"inventoryItems": 5,
"activeBuyOrders": 3,
"activeListings": 2,
"currency": "USD"
}

MarketStateController_getItemOrderbook

path Parameters

steamAccountId required	string
itemId required	string

Responses

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"marketItemId": "c22ca94e-d32e-4075-bcba-f188e21855ae",
"marketHashName": "Wall Divider Pack",
"appid": 252490,
"currency": "USD",
"ourBuyPrice": 329,
"ourBuyOrderCount": 1,
"ourBuyOrderQuantity": 5,
"ourBuyOrderDate": "2019-08-24T14:15:22Z",
"highestBuyOrder": 336,
"lowestSellOrder": 406,
"centsBehindTop": 7,
"pctOfTopBuy": 97.9,
"quantityAhead": 42,
"quantityAtOurPrice": 57,
"buyLevels": [{"price": 329,
"quantity": 12,
"cumulativeQuantity": 57,
"isOurPrice": true
}
],
"sellLevels": [{"price": 329,
"quantity": 12,
"cumulativeQuantity": 57,
"isOurPrice": true
}
],
"ok": true,
"reason": { },
"checkedAt": "2019-08-24T14:15:22Z"
}

MarketStateController_bulkMoveItems

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

itemIds required	Array of strings <uuid> [ items <uuid > ]
groupId	string or null <uuid>

Responses

Request samples

Payload

Content type

application/json

{"itemIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

Response samples

200

Content type

application/json

{"itemsMoved": 12,
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55"
}

MarketStateController_bulkDeleteItems

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

scope	string Enum: "selected" "query"
itemIds	Array of strings <uuid> [ items <uuid > ]
appid	number
groupId	string or null <uuid>
search	string
status	string

Responses

Request samples

Payload

Content type

application/json

{"scope": "selected",
"itemIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"appid": 252490,
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"search": "Abyss",
"status": "eligible"
}

Response samples

200

Content type

application/json

{"itemsDeleted": 12
}

MarketStateController_bulkPatchTradeState

path Parameters

steamAccountId

required

string

Responses

MarketStateController_patchItemTradeState

path Parameters

steamAccountId required	string
itemId required	string

Request Body schema: application/json
required

buyEnabled	boolean
sellEnabled	boolean
buyQuantity	object or null

Responses

Request samples

Payload

Content type

application/json

{"buyEnabled": true,
"sellEnabled": false,
"buyQuantity": 4
}

Response samples

200

Content type

application/json

{"buyEnabled": false,
"sellEnabled": false,
"buyPrice": 1000,
"sellNetPrice": 1200,
"sellGrossPrice": 1400,
"currency": "USD",
"buyQuantity": 1,
"activeBuyOrderId": { },
"activeBuyOrderCount": 0,
"activeListingCount": 0,
"inventoryCount": 1,
"marketItemId": "c22ca94e-d32e-4075-bcba-f188e21855ae",
"legacyState": { },
"updatedAt": "2019-08-24T14:15:22Z"
}

MarketStateController_cancelItemBuyOrder

path Parameters

steamAccountId required	string
itemId required	string

Responses

MarketStateController_cancelBuyOrdersByAge

path Parameters

steamAccountId

required

string

Responses

MarketStateController_removeAllListings

path Parameters

steamAccountId

required

string

Responses

MarketStateController_removeItemListings

path Parameters

steamAccountId required	string
itemId required	string

Responses

MarketStateController_listCatalogItems

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"appid": 252490,
"contextid": "2",
"marketHashName": "Black Hoodie",
"itemNameid": { },
"displayName": { },
"gameMetadata": { },
"isInTradingBase": false,
"status": "eligible",
"reason": "filters_passed",
"profitPercent": 8.62,
"priceSnapshot": {"source": "steamwebapi",
"currency": "USD",
"minPrice": 196,
"maxPrice": 229,
"listingCount": 42,
"salesCount": 310,
"coefficient": 1650,
"checkedAt": "2019-08-24T14:15:22Z"
},
"buyPrice": 156,
"sellNetPrice": 171,
"sellGrossPrice": 196
}
],
"page": 1,
"pageSize": 100,
"pageCount": 18,
"total": 1793,
"currency": "USD"
}

MarketStateController_listInventoryUnlocks

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"items": [{"marketItemId": "c22ca94e-d32e-4075-bcba-f188e21855ae",
"marketHashName": "Metal Facemask",
"displayName": { },
"appid": 252490,
"contextid": "2",
"groupId": { },
"groupName": "Main",
"assetid": "1234567890",
"quantity": 1,
"marketable": false,
"tradable": true,
"holdUntil": "2019-08-24T14:15:22Z",
"unlockBucket": "today",
"unlocksInDays": 2,
"currentPrice": 196,
"buyPrice": 150,
"sellNetPrice": 171,
"profitPercent": 8.62,
"buyEnabled": true,
"sellEnabled": true,
"listed": false,
"activeBuyOrder": false
}
],
"total": 42,
"onHold": 16,
"unlocksToday": 4,
"unlocksIn7Days": 12
}

MarketStateController_importInventoryItems

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

appid	number
contextid	string

Responses

Request samples

Payload

Content type

application/json

{"appid": 252490,
"contextid": "2"
}

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appidsScanned": [252490
],
"heldDistinct": 10,
"matchedCatalogItems": 10,
"itemsAdded": 6,
"alreadyPresent": 4,
"notInCatalog": ["string"
]
}

MarketStateController_addCatalogItemsToAccount

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

mode	string Enum: "eligible" "all"
appid	number
groupId	string <uuid>
limit	number
offset	number
priceMin	number
priceMax	number
salesPerDayMin	number
salesPerDayMax	number
excludeWeapons	boolean
excludeStickersPatches	boolean
excludeSouvenirs	boolean
excludeAgents	boolean
excludeGraffiti	boolean
excludeCharms	boolean
excludeCasesKeysToolsOther	boolean
catalogItemIds	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"mode": "eligible",
"appid": 252490,
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"limit": 500,
"offset": 0,
"priceMin": 0.5,
"priceMax": 10,
"salesPerDayMin": 3,
"salesPerDayMax": 50,
"excludeWeapons": true,
"excludeStickersPatches": true,
"excludeSouvenirs": true,
"excludeAgents": true,
"excludeGraffiti": true,
"excludeCharms": true,
"excludeCasesKeysToolsOther": true,
"catalogItemIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"catalogItemsScanned": 128,
"eligible": 83,
"itemsAdded": 70,
"alreadyPresent": 13,
"rejected": 45,
"skippedByLimit": 0,
"reasons": { }
}

MarketStateController_previewCatalogItemsForAccount

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

mode	string Enum: "eligible" "all"
appid	number
groupId	string <uuid>
limit	number
offset	number
priceMin	number
priceMax	number
salesPerDayMin	number
salesPerDayMax	number
excludeWeapons	boolean
excludeStickersPatches	boolean
excludeSouvenirs	boolean
excludeAgents	boolean
excludeGraffiti	boolean
excludeCharms	boolean
excludeCasesKeysToolsOther	boolean
catalogItemIds	Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Payload

Content type

application/json

{"mode": "eligible",
"appid": 252490,
"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"limit": 500,
"offset": 0,
"priceMin": 0.5,
"priceMax": 10,
"salesPerDayMin": 3,
"salesPerDayMax": 50,
"excludeWeapons": true,
"excludeStickersPatches": true,
"excludeSouvenirs": true,
"excludeAgents": true,
"excludeGraffiti": true,
"excludeCharms": true,
"excludeCasesKeysToolsOther": true,
"catalogItemIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
]
}

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"catalogItemsScanned": 128,
"eligible": 83,
"itemsAdded": 70,
"alreadyPresent": 13,
"rejected": 45,
"skippedByLimit": 0,
"reasons": { }
}

MarketStateController_importLegacySettings

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

object (Object)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

201

Content type

application/json

{"runtimeSettings": {"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"settings": { },
"legacySettings": { },
"updatedAt": "2019-08-24T14:15:22Z"
},
"strategyProfile": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"name": "Default sell strategy",
"algorithm": "AVG",
"algorithmBuy": "AVG",
"settings": { },
"legacyAliases": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"importedKeys": 82,
"runtimeKeys": ["string"
],
"strategyKeys": ["string"
]
}

MarketStateController_importListingsSnapshot

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

	object
listings required	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"currency": { },
"listings": [{ }
]
}

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"listingsProcessed": 614,
"uniqueItems": 200,
"itemsUpserted": 200,
"catalogItemsUpserted": 200,
"priceSnapshotsCreated": 200
}

MarketStateController_createGroup

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

appid required	number
name required	string
legacyGroupId	string
sortOrder	number
	object

Responses

Request samples

Payload

Content type

application/json

{"appid": 252490,
"name": "High volume skins",
"legacyGroupId": "legacy-group-1",
"sortOrder": 0,
"metadata": { }
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"name": "High volume skins",
"legacyGroupId": "legacy-group-1",
"sortOrder": 0,
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

MarketStateController_listGroups

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"name": "High volume skins",
"legacyGroupId": "legacy-group-1",
"sortOrder": 0,
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

MarketStateController_updateGroup

path Parameters

steamAccountId required	string
groupId required	string

Request Body schema: application/json
required

name	string
sortOrder	number
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "High volume skins",
"sortOrder": 0,
"metadata": { }
}

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"name": "High volume skins",
"legacyGroupId": "legacy-group-1",
"sortOrder": 0,
"metadata": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

MarketStateController_deleteGroup

path Parameters

steamAccountId required	string
groupId required	string

Responses

Response samples

200

Content type

application/json

{"groupId": "eb54e96e-21b8-4f54-9cd4-80fccbd06f55",
"itemsDeleted": 42,
"groupDeleted": true
}

MarketStateController_createStrategyProfile

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

name required	string
algorithm	string
algorithmBuy	string
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"name": "Default sell strategy",
"algorithm": "AVG",
"algorithmBuy": "AVG",
"settings": { },
"legacyAliases": { }
}

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"name": "Default sell strategy",
"algorithm": "AVG",
"algorithmBuy": "AVG",
"settings": { },
"legacyAliases": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

MarketStateController_listStrategyProfiles

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"name": "Default sell strategy",
"algorithm": "AVG",
"algorithmBuy": "AVG",
"settings": { },
"legacyAliases": { },
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

MarketStateController_upsertRuntimeSettings

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

	object
	object

Responses

Request samples

Payload

Content type

application/json

{"settings": { },
"legacySettings": { }
}

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"settings": { },
"legacySettings": { },
"updatedAt": "2019-08-24T14:15:22Z"
}

MarketStateController_getRuntimeSettings

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"settings": { },
"legacySettings": { },
"updatedAt": "2019-08-24T14:15:22Z"
}

decisions

DecisionsController_getBuyOrderCompetitiveness

path Parameters

steamAccountId

required

string

Responses

DecisionsController_listJobs

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"type": "buy_analysis",
"status": "queued",
"priority": 0,
"payload": { },
"attempts": 0,
"lastError": { },
"scheduledAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
}
]

DecisionsController_getJobResult

path Parameters

steamAccountId required	string
jobQueueId required	string

Responses

Response samples

200

Content type

application/json

{"job": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"type": "buy_analysis",
"status": "queued",
"priority": 0,
"payload": { },
"attempts": 0,
"lastError": { },
"scheduledAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
},
"audit": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"category": "decision.job_succeeded",
"severity": "info",
"createdAt": "2019-08-24T14:15:22Z"
},
"result": { },
"error": { }
}

DecisionsController_retryJob

path Parameters

steamAccountId required	string
jobQueueId required	string

Responses

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"type": "buy_analysis",
"jobQueueId": "4e8df10a-ec05-4672-82ee-3a1100dc2c76",
"bullJobId": "bull-job-1",
"status": "queued"
}

DecisionsController_cancelJob

path Parameters

steamAccountId required	string
jobQueueId required	string

Responses

Response samples

201

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"type": "buy_analysis",
"status": "queued",
"priority": 0,
"payload": { },
"attempts": 0,
"lastError": { },
"scheduledAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
}

DecisionsController_getJob

path Parameters

steamAccountId required	string
jobQueueId required	string

Responses

Response samples

200

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"type": "buy_analysis",
"status": "queued",
"priority": 0,
"payload": { },
"attempts": 0,
"lastError": { },
"scheduledAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
}

trading

RunnerController_getStatus

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"status": "running",
"currentJob": "cycle_dispatch",
"blockedReason": null,
"microbanUntil": "2019-08-24T14:15:22Z",
"runnerIntent": "running",
"effectiveStatus": "paused_by_steam_cooldown",
"isPausedByCooldown": true,
"cooldownUntil": "2019-08-24T14:15:22Z",
"autoResume": true,
"throttleState": { },
"settings": {"appid": 252490,
"runnerJobs": ["sell_analysis"
]
},
"safety": {"allowed": true,
"reasons": ["string"
]
},
"jobs": {"due": [{"type": "sell_analysis",
"cadenceMs": 300000,
"lastScheduledAt": "2019-08-24T14:15:22Z"
}
],
"skipped": [{"type": "sell_analysis",
"cadenceMs": 300000,
"lastScheduledAt": "2019-08-24T14:15:22Z"
}
]
}
}

RunnerController_diagnostics

path Parameters

steamAccountId

required

string

Responses

RunnerController_start

path Parameters

steamAccountId

required

string

Responses

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"queuedJobs": [{"type": "sell_analysis",
"jobQueueId": "4e8df10a-ec05-4672-82ee-3a1100dc2c76",
"bullJobId": "bull-job-1"
}
],
"blockedReason": "account_not_ready",
"status": "running",
"currentJob": "cycle_dispatch"
}

RunnerController_stop

path Parameters

steamAccountId

required

string

Responses

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"status": "stopped",
"currentJob": null,
"blockedReason": null
}

RunnerController_tick

path Parameters

steamAccountId

required

string

Responses

Response samples

201

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"queuedJobs": [{"type": "sell_analysis",
"jobQueueId": "4e8df10a-ec05-4672-82ee-3a1100dc2c76",
"bullJobId": "bull-job-1"
}
],
"blockedReason": "account_not_ready"
}

RunnerController_sellPhantomCleanup

path Parameters

steamAccountId

required

string

Responses

account-dashboard

AccountDashboardController_getOverview

Responses

Response samples

200

Content type

application/json

{"generatedAt": "2019-08-24T14:15:22Z",
"summary": {"totalAccounts": 5,
"statuses": {"draft": 1,
"ready": 3,
"blocked": 1,
"disabled": 0
},
"needsAttention": 2,
"totalBalanceByCurrency": {"USD": 12345
},
"totalHeldByCurrency": {"USD": 82
},
"totalInventoryValueByCurrency": {"USD": 6789
},
"totalOnSaleValueByCurrency": {"USD": 4321
},
"totalOnOrdersValueByCurrency": {"USD": 4321
},
"totalNetWorthByCurrency": {"USD": 24316
},
"totalActiveBuyOrders": 12,
"totalActiveBuyOrderQuantity": 24
},
"accounts": [{"account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft",
"sessionState": { },
"walletBalance": "10000",
"walletDelayedBalance": "82",
"setupBootstrapAppids": [730,
252490
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"runnerStatus": "running",
"proxyStatus": "healthy",
"safety": {"allowed": true,
"reasons": ["string"
]
},
"jobsSummary": {"total": 16,
"counts": {"queued": 3,
"running": 1,
"succeeded": 10,
"failed": 2,
"cancelled": 0
}
},
"setupComplete": true,
"missingSetupSteps": ["string"
],
"readyForLiveRun": false,
"attentionReasons": ["string"
],
"inventory": {"count": 12,
"valueMinor": 6789,
"currency": "USD"
},
"onSale": {"valueMinor": 4321,
"currency": "USD",
"count": 7
},
"onOrders": {"valueMinor": 4321,
"currency": "USD",
"count": 5,
"quantity": 10
},
"valuation": {"id": "7f7b6f19-7d4e-4b0d-9891-851c18f8db5c",
"capturedAt": "2019-08-24T14:15:22Z",
"marketStateSyncedAt": "2019-08-24T14:15:22Z",
"oldestPriceCheckedAt": "2019-08-24T14:15:22Z",
"newestPriceCheckedAt": "2019-08-24T14:15:22Z",
"valuationMethod": "latest_floor_gross",
"netWorthEstimate": 196604,
"walletBalance": 167970,
"held": 0,
"inventoryValue": 17072,
"onSaleValue": 11562,
"onOrdersValueExcluded": 812956,
"onOrdersExcludedFromNetWorth": true,
"formula": "Net worth estimate = wallet + held + inventory value + on-sale value. Buy orders are excluded and shown separately as exposure.",
"valuationStale": true,
"mixedFreshness": true,
"settlementGapPossible": false,
"stalePriceRows": 87,
"stalePriceValue": 19000,
"stalePriceRatio": 0.76,
"missingPriceRows": 0,
"walletDelta": 0,
"heldDelta": 0,
"inventoryValueDelta": -4904,
"onSaleValueDelta": 1868,
"onOrdersDeltaExcluded": 0,
"netWorthDelta": -3036,
"sinceStartOfDay": {"walletDelta": 757,
"heldDelta": 0,
"inventoryValueDelta": -918,
"onSaleValueDelta": 181,
"onOrdersDeltaExcluded": -130,
"netWorthDelta": 20
}
},
"health": {"blockedReason": "session_expired",
"microbanUntil": "2019-08-24T14:15:22Z",
"isPausedByCooldown": true,
"cooldownUntil": "2019-08-24T14:15:22Z",
"autoResume": true,
"runnerIntent": "running",
"effectiveStatus": "paused_by_steam_cooldown",
"buyPausedUntil": "2019-08-24T14:15:22Z",
"lastContactAt": "2019-08-24T14:15:22Z",
"lastSteamStatusCode": 429,
"lastSteamResponseCategory": "rate_limited",
"lastSteamRequestOk": false,
"lastSteamSessionExpired": false,
"lastSteamProxyUsed": true
},
"checks": [{"key": "proxy",
"status": "ok"
}
]
}
]
}

AccountDashboardController_getDashboard

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"generatedAt": "2019-08-24T14:15:22Z",
"account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft",
"sessionState": { },
"walletBalance": "10000",
"walletDelayedBalance": "82",
"setupBootstrapAppids": [730,
252490
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"proxy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"protocol": "http",
"host": "127.0.0.1",
"port": 8080,
"expectedIp": "203.0.113.10",
"lastStatus": "unknown",
"lastLatencyMs": 123,
"hasUsername": true,
"hasPassword": true,
"updatedAt": "2019-08-24T14:15:22Z"
},
"runner": {"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"status": "running",
"currentJob": "cycle_dispatch",
"blockedReason": null,
"microbanUntil": "2019-08-24T14:15:22Z",
"runnerIntent": "running",
"effectiveStatus": "paused_by_steam_cooldown",
"isPausedByCooldown": true,
"cooldownUntil": "2019-08-24T14:15:22Z",
"autoResume": true,
"throttleState": { },
"settings": {"appid": 252490,
"runnerJobs": ["sell_analysis"
]
},
"safety": {"allowed": true,
"reasons": ["string"
]
},
"jobs": {"due": [{"type": "sell_analysis",
"cadenceMs": 300000,
"lastScheduledAt": "2019-08-24T14:15:22Z"
}
],
"skipped": [{"type": "sell_analysis",
"cadenceMs": 300000,
"lastScheduledAt": "2019-08-24T14:15:22Z"
}
]
}
},
"jobs": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"appid": 252490,
"type": "buy_analysis",
"status": "queued",
"priority": 0,
"payload": { },
"attempts": 0,
"lastError": { },
"scheduledAt": "2019-08-24T14:15:22Z",
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
}
],
"auditEvents": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": { },
"appid": 252490,
"category": "runner.started",
"severity": "debug",
"message": "Trading started",
"actorType": "service_api",
"actorName": "openclaw",
"requestId": "frontend-request-1",
"data": { },
"createdAt": "2019-08-24T14:15:22Z"
}
]
}

account-setup-status

AccountSetupStatusController_getStatus

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"generatedAt": "2019-08-24T14:15:22Z",
"account": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
"displayName": "Main Steam",
"steamId": "76561198000000000",
"status": "draft",
"sessionState": { },
"walletBalance": "10000",
"walletDelayedBalance": "82",
"setupBootstrapAppids": [730,
252490
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"secrets": {"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"hasLogin": true,
"hasPassword": true,
"hasMaFile": false,
"updatedAt": "2019-08-24T14:15:22Z"
},
"sessionCredentials": {"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"hasSessionId": true,
"hasCookie": true,
"updatedAt": "2019-08-24T14:15:22Z"
},
"proxy": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"steamAccountId": "48aaee53-8302-4970-b717-8faa8713330a",
"protocol": "http",
"host": "127.0.0.1",
"port": 8080,
"expectedIp": "203.0.113.10",
"lastStatus": "unknown",
"lastLatencyMs": 123,
"hasUsername": true,
"hasPassword": true,
"updatedAt": "2019-08-24T14:15:22Z"
},
"runnerSafety": {"allowed": true,
"reasons": ["string"
]
},
"missingSteps": ["string"
],
"blockingReasons": ["string"
],
"setupComplete": false,
"readyForLiveRun": false
}

legacy-import

LegacyImportController_dryRunDatabase

Request Body schema: application/json
required

	object
	object
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"items": { },
"groups": { },
"group_settings": { },
"config": { }
}

Response samples

201

Content type

application/json

{"sourceType": "indexeddb-json",
"recordsRead": 42,
"recordsImported": 3,
"warnings": [{"severity": "info",
"code": "unknown_store",
"message": "Unsupported legacy store preserved in report.",
"path": "items.0"
}
],
"sampleKeys": ["items",
"config"
],
"items": [{"appid": 252490,
"contextid": "2",
"marketHashName": "Metal Facemask",
"itemNameid": "string",
"displayName": "string",
"gameMetadata": { },
"legacyState": { },
"tradeState": {"buyEnabled": false,
"sellEnabled": false,
"buyPrice": 1000,
"sellNetPrice": 1200,
"sellGrossPrice": 1400,
"currency": "USD",
"buyQuantity": 1,
"activeBuyOrderId": { },
"activeBuyOrderCount": 0,
"activeListingCount": 0,
"inventoryCount": 1
}
}
],
"groups": [{"appid": 252490,
"name": "High volume skins",
"legacyGroupId": "legacy-group-1",
"sortOrder": 0,
"metadata": { }
}
],
"strategyProfiles": [{"name": "Default sell strategy",
"algorithm": "AVG",
"algorithmBuy": "AVG",
"settings": { },
"legacyAliases": { }
}
],
"runtimeSettings": {"settings": { },
"legacySettings": { }
}
}

LegacyImportController_applyDatabase

path Parameters

steamAccountId

required

string

Request Body schema: application/json
required

	object
	object
	object
	object

Responses

Request samples

Payload

Content type

application/json

{"items": { },
"groups": { },
"group_settings": { },
"config": { }
}

Response samples

201

Content type

application/json

{"sourceType": "indexeddb-json",
"recordsRead": 42,
"recordsImported": 3,
"warnings": [{"severity": "info",
"code": "unknown_store",
"message": "Unsupported legacy store preserved in report.",
"path": "items.0"
}
],
"sampleKeys": ["items",
"config"
],
"items": [{"appid": 252490,
"contextid": "2",
"marketHashName": "Metal Facemask",
"itemNameid": "string",
"displayName": "string",
"gameMetadata": { },
"legacyState": { },
"tradeState": {"buyEnabled": false,
"sellEnabled": false,
"buyPrice": 1000,
"sellNetPrice": 1200,
"sellGrossPrice": 1400,
"currency": "USD",
"buyQuantity": 1,
"activeBuyOrderId": { },
"activeBuyOrderCount": 0,
"activeListingCount": 0,
"inventoryCount": 1
}
}
],
"groups": [{"appid": 252490,
"name": "High volume skins",
"legacyGroupId": "legacy-group-1",
"sortOrder": 0,
"metadata": { }
}
],
"strategyProfiles": [{"name": "Default sell strategy",
"algorithm": "AVG",
"algorithmBuy": "AVG",
"settings": { },
"legacyAliases": { }
}
],
"runtimeSettings": {"settings": { },
"legacySettings": { }
},
"imported": {"groups": 1,
"strategyProfiles": 1,
"items": 1,
"runtimeSettings": 1,
"mode": "upsert"
}
}

trading-stats

TradingStatsController_getRealizedPnl

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"currency": "USD",
"totals": {"buyCount": 19,
"sellCount": 12,
"totalSpent": 1240,
"grossProceeds": 1500,
"netProceeds": 1300,
"feesPaid": 200,
"realizedPnl": 60,
"proceedsWithoutCostBasis": 0,
"ambiguousCostBasisCount": 1,
"ambiguousCostBasisProceeds": 99,
"closedTrades": 12,
"winRate": 0.66,
"avgHoldDays": 2.4,
"roi": 8.5,
"openPositionCost": 1500,
"openPositionValue": 1720,
"unrealizedPnl": 220
},
"freshness": {"ledgerRows": 1234,
"lastHistorySyncAt": "2019-08-24T14:15:22Z",
"latestTradeOccurredAt": "2019-08-24T14:15:22Z",
"historyLagHours": 4.5,
"status": "fresh",
"incompleteReasons": ["ambiguous_cost_basis"
]
},
"items": [{"marketHashName": "Blue Hoodie",
"appid": 252490,
"buyQuantity": 4,
"sellQuantity": 3,
"totalSpent": 40,
"totalProceeds": 33,
"feesPaid": 5,
"realizedPnl": 3,
"pnlReason": "ambiguous_cost_basis",
"ambiguousCostBasisProceeds": 99
}
]
}

TradingStatsController_getDaily

path Parameters

steamAccountId

required

string

query Parameters

days

required

string

Responses

Response samples

200

Content type

application/json

{"currency": "USD",
"rows": [{"date": "2026-01-21",
"walletBalance": 23746,
"held": 0,
"onSaleValue": 82382,
"inventoryValue": 0,
"onOrdersValue": 0,
"netWorth": 106128,
"walletDelta": 0,
"inventoryValueDelta": -4904,
"onSaleValueDelta": 1868,
"onOrdersDeltaExcluded": 0,
"netWorthDelta": -3036,
"profit": 785,
"profitPercent": 0.74
}
]
}

TradingStatsController_getPnlTimeline

path Parameters

steamAccountId

required

string

Responses

Response samples

200

Content type

application/json

{"currency": "USD",
"points": [{"date": "2026-01-22",
"realized": 785,
"cumulative": 1240
}
]
}

TradingStatsController_getLedger

path Parameters

steamAccountId

required

string

query Parameters

limit

required

string

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"marketHashName": "Blue Hoodie",
"side": "buy",
"quantity": 1,
"unitPrice": 13,
"fee": 0,
"net": 13,
"currency": "USD",
"source": "myhistory",
"occurredAt": "2019-08-24T14:15:22Z",
"pnlAmount": 12,
"pnlKind": "current_estimate",
"pnlReason": "missing_current_sell_price",
"costBasis": 16,
"estimatedSellNet": 28,
"matchedQuantity": 1
}
]

TradingStatsController_getLedgerBasisRepairDiagnostics

path Parameters

steamAccountId

required

string

Responses

TradingStatsController_ingest

path Parameters

steamAccountId

required

string

query Parameters

pages

required

string

Responses

Response samples

200

Content type

application/json

{"ok": true,
"fetched": 200,
"ingested": 37
}

PortfolioController_getStats

Responses

Response samples

200

Content type

application/json

{"accountCount": 4,
"byCurrency": [{"currency": "USD",
"accounts": 3,
"realizedPnl": 0,
"unrealizedPnl": 0,
"totalPnl": 0,
"netWorth": 0,
"totalSpent": 0,
"netProceeds": 0,
"feesPaid": 0,
"openPositionValue": 0,
"openPositionCost": 0,
"closedTrades": 0,
"roi": { },
"winRate": { },
"avgHoldDays": { }
}
],
"accounts": [{"steamAccountId": "string",
"displayName": "string",
"currency": "USD",
"netWorth": 0,
"realizedPnl": 0,
"unrealizedPnl": 0,
"totalPnl": 0,
"roi": { }
}
]
}

SteamMarketRunner API (0.1.0)

notifications

NotificationSettingsController_get

Responses

Response samples

NotificationSettingsController_update

Responses

Response samples

NotificationFeedController_feed

query Parameters

Responses

Response samples

NotificationFeedController_activity

query Parameters

Responses

Response samples

UserAuditController_list

query Parameters

Responses

Response samples

announcements

AnnouncementsController_active

Responses

Response samples

AnnouncementsController_dismiss

path Parameters

Responses

currency

CurrencyRatesController_get

Responses

Response samples

preferences

PreferencesController_get

Responses

Response samples

PreferencesController_update

Responses

Response samples

auth

AuthController_startGoogleOAuth

Responses

AuthController_completeGoogleOAuth

Responses

AuthController_signup

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AuthController_resendEmailVerification

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AuthController_confirmEmailVerification

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AuthController_login

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AuthController_requestPasswordReset

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AuthController_confirmPasswordReset

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

AuthController_me

Responses

Response samples

AuthController_logout

Responses

Response samples

AuthController_getServiceAuth

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required