# gofurry/steam-go architecture

> Architecture diagram of the GitHub repository gofurry/steam-go, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-01). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/gofurry/steam-go
- Repository: https://github.com/gofurry/steam-go

## Overview

steam-go is a Go SDK for official Steam Web API calls, read-only Storefront/Community/Market queries, and optional Steam-focused addons. The main workflow is to configure a Client, call a grouped API or Web service, and receive typed or raw results through shared request execution. The README documents the product surfaces; sampled service files show API services holding the shared executor, while the source index shows service-to-executor imports. Addon implementation details and most request-runtime internals were not sampled, so their internal links are omitted. The README mentions an assets addon, but no assets source path appears in the supplied tree.

Main entry points: [`internal/request`](https://github.com/gofurry/steam-go/tree/main/internal/request) (Request executor), [`web`](https://github.com/gofurry/steam-go/tree/main/web) (Web query services), [`client.go`](https://github.com/gofurry/steam-go/blob/main/client.go) (SDK Client), [`web/storefront/service.go`](https://github.com/gofurry/steam-go/blob/main/web/storefront/service.go) (Storefront queries)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Client surface"]
  node_client["SDK Client<br/>[client.go]"]
end

subgraph group_official["Official API"]
  node_api_services["Grouped API services"]
  node_api_service_impl["API service methods<br/>[service.go]"]
end

subgraph group_web["Read-only Web"]
  node_web_services["Web query services"]
  node_storefront["Storefront queries<br/>[service.go]"]
  node_community["Community queries<br/>[service.go]"]
  node_market["Market queries<br/>[service.go]"]
end

subgraph group_runtime["Request runtime"]
  node_executor["Request executor"]
  node_transport["HTTP transport"]
  node_request_controls["Traffic controls"]
end

subgraph group_addons["Addons"]
  node_openid["OpenID verification<br/>[verifier.go]"]
  node_websession["Web login sessions<br/>[client.go]"]
  node_freeclaim["Free promotion claims<br/>[client.go]"]
  node_markup["Markup conversion<br/>[bbcode.go]"]
  node_vdf["VDF parsing<br/>[vdf.go]"]
  node_a2s["A2S queries<br/>[bridge.go]"]
end

node_caller(("Go application"))
node_steam_api["Steam Web API"]

node_caller -->|"configures"| node_client
node_client -->|"exposes"| node_api_services
node_api_services -.->|"includes"| node_api_service_impl
node_api_service_impl -->|"uses"| node_executor
node_executor -.->|"requests"| node_steam_api
node_client -->|"exposes"| node_web_services
node_web_services -.->|"includes"| node_storefront
node_web_services -.->|"includes"| node_community
node_web_services -.->|"includes"| node_market
node_storefront -->|"uses"| node_executor
node_community -->|"uses"| node_executor
node_market -->|"uses"| node_executor
node_executor -.->|"delegates to"| node_transport
node_transport -.->|"applies"| node_request_controls
node_caller -->|"verifies login"| node_openid
node_caller -->|"manages session"| node_websession
node_caller -->|"claims promotion"| node_freeclaim
node_freeclaim -->|"uses queries"| node_storefront
node_caller -->|"converts markup"| node_markup
node_caller -->|"parses VDF"| node_vdf
node_caller -->|"queries servers"| node_a2s

click node_client "https://github.com/gofurry/steam-go/blob/main/client.go"
click node_api_services "https://github.com/gofurry/steam-go/tree/main/api"
click node_api_service_impl "https://github.com/gofurry/steam-go/blob/main/api/steamuser/service.go"
click node_web_services "https://github.com/gofurry/steam-go/tree/main/web"
click node_storefront "https://github.com/gofurry/steam-go/blob/main/web/storefront/service.go"
click node_community "https://github.com/gofurry/steam-go/blob/main/web/community/service.go"
click node_market "https://github.com/gofurry/steam-go/blob/main/web/market/service.go"
click node_executor "https://github.com/gofurry/steam-go/tree/main/internal/request"
click node_transport "https://github.com/gofurry/steam-go/tree/main/internal/transport"
click node_request_controls "https://github.com/gofurry/steam-go/tree/main/internal/traffic"
click node_openid "https://github.com/gofurry/steam-go/blob/main/addons/openid/verifier.go"
click node_websession "https://github.com/gofurry/steam-go/blob/main/addons/websession/client.go"
click node_freeclaim "https://github.com/gofurry/steam-go/blob/main/addons/freeclaim/client.go"
click node_markup "https://github.com/gofurry/steam-go/blob/main/addons/markup/bbcode.go"
click node_vdf "https://github.com/gofurry/steam-go/blob/main/addons/vdf/vdf.go"
click node_a2s "https://github.com/gofurry/steam-go/blob/main/addons/a2s/bridge.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_client toneBlue
class node_api_services,node_api_service_impl toneAmber
class node_web_services,node_storefront,node_community,node_market,node_steam_api toneMint
class node_executor,node_transport,node_request_controls toneRose
class node_openid,node_websession,node_freeclaim,node_markup,node_vdf,node_a2s,node_caller toneIndigo
```

## Components

### Client surface

- [SDK Client](https://github.com/gofurry/steam-go/blob/main/client.go): `client.go`

### Official API

- [Grouped API services](https://github.com/gofurry/steam-go/tree/main/api): `api`
- [API service methods](https://github.com/gofurry/steam-go/blob/main/api/steamuser/service.go): `api/steamuser/service.go`

### Read-only Web

- [Web query services](https://github.com/gofurry/steam-go/tree/main/web): `web`
- [Storefront queries](https://github.com/gofurry/steam-go/blob/main/web/storefront/service.go): `web/storefront/service.go`
- [Community queries](https://github.com/gofurry/steam-go/blob/main/web/community/service.go): `web/community/service.go`
- [Market queries](https://github.com/gofurry/steam-go/blob/main/web/market/service.go): `web/market/service.go`

### Request runtime

- [Request executor](https://github.com/gofurry/steam-go/tree/main/internal/request): `internal/request`
- [HTTP transport](https://github.com/gofurry/steam-go/tree/main/internal/transport): `internal/transport`
- [Traffic controls](https://github.com/gofurry/steam-go/tree/main/internal/traffic): `internal/traffic`

### Addons

- [OpenID verification](https://github.com/gofurry/steam-go/blob/main/addons/openid/verifier.go): `addons/openid/verifier.go`
- [Web login sessions](https://github.com/gofurry/steam-go/blob/main/addons/websession/client.go): `addons/websession/client.go`
- [Free promotion claims](https://github.com/gofurry/steam-go/blob/main/addons/freeclaim/client.go): `addons/freeclaim/client.go`
- [Markup conversion](https://github.com/gofurry/steam-go/blob/main/addons/markup/bbcode.go): `addons/markup/bbcode.go`
- [VDF parsing](https://github.com/gofurry/steam-go/blob/main/addons/vdf/vdf.go): `addons/vdf/vdf.go`
- [A2S queries](https://github.com/gofurry/steam-go/blob/main/addons/a2s/bridge.go): `addons/a2s/bridge.go`

### Other components

- **Go application**
- **Steam Web API**

## Connections

- Go application → SDK Client: configures
- SDK Client → Grouped API services: exposes (evidence: `client.go`)
- Grouped API services → API service methods: includes
- API service methods → Request executor: uses (evidence: `api/steamuser/service.go`)
- Request executor → Steam Web API: requests
- SDK Client → Web query services: exposes (evidence: `client.go`)
- Web query services → Storefront queries: includes
- Web query services → Community queries: includes
- Web query services → Market queries: includes
- Storefront queries → Request executor: uses (evidence: `web/storefront/service.go`)
- Community queries → Request executor: uses (evidence: `web/community/service.go`)
- Market queries → Request executor: uses (evidence: `web/market/service.go`)
- Request executor → HTTP transport: delegates to
- HTTP transport → Traffic controls: applies
- Go application → OpenID verification: verifies login
- Go application → Web login sessions: manages session
- Go application → Free promotion claims: claims promotion
- Free promotion claims → Storefront queries: uses queries (evidence: `addons/freeclaim/client.go`)
- Go application → Markup conversion: converts markup
- Go application → VDF parsing: parses VDF
- Go application → A2S queries: queries servers
