# gfapi

> Gameflip API

Latest version **0.1.1** (published 2021-12-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install gfapi
pnpm add gfapi
yarn add gfapi
bun add gfapi
```

## 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.1.1 |
| Published | 2021-12-12 |
| First published | 2021-12-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.5.0 |
| Dependencies | 7 |
| Unpacked size | 32 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| Author | The Gamer3514 |
| Maintainers | thegamer3514 |
| Keywords | Gameflip |

## Links

- npm: https://www.npmjs.com/package/gfapi
- Repository: https://github.com/iJJi/gfapi
- Homepage: https://github.com/iJJi/gfapi#readme
- Issues: https://github.com/iJJi/gfapi/issues
- npm.io page: https://npm.io/package/gfapi

## Dependencies (7)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [bunyan](https://npm.io/package/bunyan.md) ^1.8.15
- [bluebird](https://npm.io/package/bluebird.md) ^3.7.2
- [file-type](https://npm.io/package/file-type.md) ^14.7.1
- [speakeasy](https://npm.io/package/speakeasy.md) ^2.0.0
- [http-errors](https://npm.io/package/http-errors.md) ^1.8.0
- [promise-ratelimit](https://npm.io/package/promise-ratelimit.md) ^0.0.3

## Recent versions

- 0.1.1 (latest) — 2021-12-12

## README

# GFAPI

Node.js API bindings and sample code create Gameflip listings for Steam items
* [REST API documentation](https://gameflip.github.io/gfapi)
* [Node.js GFAPI Bindings](https://gameflip.github.io/gfapi/gfapi/0.1.1/GfApi.html)
* Node.js Sample Code
  * [Steam Bulk Listing](https://gameflip.github.io/gfapi/samples/bulk_listing.html)
  * [Rocket League Listing](https://gameflip.github.io/gfapi/samples/rl_listing.html)
  * [Gift Card Listing](https://gameflip.github.io/gfapi/samples/giftcard_listing.html)
  * [Search Listing](https://gameflip.github.io/gfapi/samples/search_listing.html)
  * [My Listings](https://gameflip.github.io/gfapi/samples/my_listings.html)
  * [My Wallet](https://gameflip.github.io/gfapi/samples/my_wallet.html)

### API Key and OTP secret

To get the API Key and secret, contact Gameflip support.
During Beta, API Keys are only being given out to select customers.

### 1. Install [Git](https://git-scm.com/downloads), [NodeJS v12 LTS](https://nodejs.org), and [Python 2.7.14](https://www.python.org/downloads/release/python-2714/)

### 2. Download sample code
```
  git clone https://github.com/gameflip/gfapi.git
```

### 3. Install dependencies
```
  cd gfapi
  npm install
```

(Optional) Mac and Linux:  
This command converts `src/samples/*.js` files into HTML as seen on the [documentation website](https://gameflip.github.io/gfapi/samples/search_listing.html).
```
  npm run-script docs
```

### 4. Run Sample Code
Mac and Linux:
```
  export GFAPI_KEY=<my_api_key>
  export GFAPI_SECRET=<my_api_secret>
  node src/samples/search_listing.js
```
Windows:
```
  SET GFAPI_KEY=<my_api_key>
  SET GFAPI_SECRET=<my_api_secret>
  node src\samples\search_listing.js
```

### 5. For your own project, you just install gfapi npm
```
npm install 'gameflip/gfapi'
```

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