# steam-miniprofile

> Fetches miniprofile data on any steam user

Latest version **0.0.8** (published 2021-07-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install steam-miniprofile
pnpm add steam-miniprofile
yarn add steam-miniprofile
bun add steam-miniprofile
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2021-07-11 |
| First published | 2021-01-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.3 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Mengh. |
| Maintainers | hilliamt |

## Links

- npm: https://www.npmjs.com/package/steam-miniprofile
- Repository: https://github.com/HilliamT/node-steam-miniprofile
- Homepage: https://github.com/HilliamT/node-steam-miniprofile#readme
- Issues: https://github.com/HilliamT/node-steam-miniprofile/issues
- npm.io page: https://npm.io/package/steam-miniprofile

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [steamid](https://npm.io/package/steamid.md) ^1.1.3

## Recent versions

- 0.0.8 (latest) — 2021-07-11
- 0.0.7 — 2021-07-07
- 0.0.6 — 2021-01-05
- 0.0.5 — 2021-01-05
- 0.0.4 — 2021-01-05
- 0.0.3 — 2021-01-05
- 0.0.2 — 2021-01-05
- 0.0.1 — 2021-01-05

## README

# node-steam-miniprofile
<img src="https://badgen.net/npm/v/steam-miniprofile" /> <img src="https://badgen.net/npm/dm/steam-miniprofile" /> <img src="https://badgen.net/npm/dt/steam-miniprofile" />
### **Table of Contents**
- [Introduction](#introduction)
- [Getting Started](#getting-started)
    - [Usage](#usage)
    - [Example](#example)
    - [Types](#types)

### Introduction
A module to fetch Steam miniprofile data on any Steam user. This wraps around the `https://steamcommunity.com/miniprofile/<ACCOUNTID>/json` endpoint.

### Getting Started
You can download this from npm using the following command.

```bash
npm install steam-miniprofile
```

##### Usage

This module exports two functions, `getMiniprofile` and `getMiniprofileByID64` which both return a Promise that resolves to a `Miniprofile`.

##### Example

```typescript
const accountid = "120816906";
const steamid64 = "76561198081082634";
...
const miniprofile = await getMiniprofile(accountid);
console.log(miniprofile.level);
...
const { level, ... } = await getMiniprofileByID64(steamid64);
console.log(level);
...
```

##### Types
The interface `Miniprofile` can be found below.

```typescript
interface MiniProfile {
    level: number;
    level_class: string; // Determines badge
    avatar_url: string; // Full image url
    persona_name: string; // Current display name

    favorite_badge?: {
        name: string;
        xp: string;
        level: number;
        description: string;
        icon: string;
    },
    profile_background?: {
        "video/webm": string;
        "video/mp4": string;
        image: string; 
    },
    avatar_frame?: string;
}
```

---
_Source: https://npm.io/package/steam-miniprofile · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._