> ## Documentation Index
> Fetch the complete documentation index at: https://docs.osintcat.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Steam Profile

> Public Steam profile by username

Look up a Steam account by its username and get the public profile.

## Parameters

**username** `string` *required*

The Steam username.

## Headers

**X-API-KEY** `string` *required*

Your API key.

## Usage

Counts as one lookup against your plan's daily allowance (Max: unlimited). When the allowance is used up, the lookup can continue at a per-lookup price charged to your balance (the module's page in the dashboard shows the price). The price applies even when the lookup finds nothing; a lookup that fails because of an error on our side is not charged.

## Example request

```bash cURL theme={null}
curl "https://www.osintcat.net/api/steam-lookup?username=gaben" \
     -H "X-API-KEY: YOUR_API_KEY"
```

```python Python theme={null}
import requests

url = "https://www.osintcat.net/api/steam-lookup"
params = {"username": "gaben"}
headers = {"X-API-KEY": "YOUR_API_KEY"}

response = requests.get(url, params=params, headers=headers, timeout=60)
print(response.status_code, response.json())
```

```javascript JS & TS theme={null}
const response = await fetch("https://www.osintcat.net/api/steam-lookup?username=gaben", {
  headers: { "X-API-KEY": "YOUR_API_KEY" },
});
console.log(response.status, await response.json());
```

```php PHP theme={null}
<?php
$curl = curl_init("https://www.osintcat.net/api/steam-lookup?username=gaben");
curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ["X-API-KEY: YOUR_API_KEY"],
]);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_RESPONSE_CODE);
curl_close($curl);
echo $status . " " . $response;
```

```go Go theme={null}
package main

import (
    "fmt"
    "io"
    "net/http"
)

func main() {
    req, _ := http.NewRequest("GET", "https://www.osintcat.net/api/steam-lookup?username=gaben", nil)
    req.Header.Set("X-API-KEY", "YOUR_API_KEY")
    resp, err := http.DefaultClient.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(resp.StatusCode, string(body))
}
```

## SDK example

The same request with the [official SDKs](https://docs.osintcat.net/sdks.md). Each one reads your key from `OSINTCAT_API_KEY`.

```typescript JS & TS theme={null}
import { OsintCatClient } from "osintcat";

const client = new OsintCatClient(); // reads OSINTCAT_API_KEY

const result = await client.steam.profile({
    username: "gaben"
});
console.log(result);
```

```python Python theme={null}
from osintcat import OsintCat

client = OsintCat()  # reads OSINTCAT_API_KEY

result = client.steam.profile(
    username="gaben",
)
print(result)
```

```go Go theme={null}
package main

import (
	"context"
	"fmt"

	osintcat "github.com/OsintCatHQ/osintcat-go"
	osintcatclient "github.com/OsintCatHQ/osintcat-go/client"
)

func main() {
	client := osintcatclient.NewClient() // reads OSINTCAT_API_KEY
	request := &osintcat.ProfileSteamRequest{
		Username: "gaben",
	}
	result, err := client.Steam.Profile(context.Background(), request)
	if err != nil {
		panic(err)
	}
	fmt.Printf("%+v\n", result)
}
```

```php PHP theme={null}
<?php
require __DIR__ . '/vendor/autoload.php';

use OsintCat\OsintCatClient;
use OsintCat\Steam\Requests\ProfileSteamRequest;

$client = new OsintCatClient(); // reads OSINTCAT_API_KEY

$result = $client->steam->profile(
    new ProfileSteamRequest([
        'username' => 'gaben',
    ]),
);
echo json_encode($result, JSON_PRETTY_PRINT), PHP_EOL;
```

## Response

`taken` is `true` when the account exists. `ExtraData` holds what the profile shows publicly; a field the profile does not have is left out. When the lookup could not be completed, `taken` is `false` and `error` says why (for example `rate_limited`, try again later).

**taken** `boolean`

Whether an account with this username exists.

**error** `string`

Present only when the lookup could not be completed.

**ExtraData** `object`

Public profile fields.

**properties**

**Username** `string`

Steam username.

**DisplayName** `string`

Profile name.

**RealName** `string`

Real name, if public.

**ProfileUrl** `string`

Profile link.

**AvatarUrl** `string`

Avatar.

**ProfileState** `number`

1 when the profile is set up.

**Visibility** `number`

3 = public, 1 = private.

**TimeCreated** `number`

Account creation (Unix time).

**LastLogoff** `number`

Last sign-off (Unix time).

**CountryCode** `string`

Country, if public.

```json 200 theme={null}
{
  "taken": true,
  "ExtraData": {
    "Username": "gaben",
    "DisplayName": "Rabscuttle",
    "ProfileUrl": "https://steamcommunity.com/profiles/76561197960287930",
    "Visibility": 3,
    "TimeCreated": 1063407589,
    "CountryCode": "US"
  }
}
```

## Errors

| Status | Error | When |
| - | - | - |
| 400 | `Missing username parameter` | No `username` given. |

See [Errors](https://docs.osintcat.net/api-reference/introduction.md#errors) for the responses every endpoint can return.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.