https://github.com/zackaryh8/altv-api-wrapper

A Node JS Wrapper for the alt:V Masterlist API
https://github.com/zackaryh8/altv-api-wrapper

altv api fivem gta gta5 nodejs ragemp typescript

Last synced: 21 days ago
JSON representation

A Node JS Wrapper for the alt:V Masterlist API

• Host: GitHub
• URL: https://github.com/zackaryh8/altv-api-wrapper
• Owner: ZackaryH8
• Created: 2021-02-05T16:43:22.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-01-09T17:57:14.000Z (about 1 year ago)
• Last Synced: 2025-01-13T11:09:58.663Z (22 days ago)
• Topics: altv, api, fivem, gta, gta5, nodejs, ragemp, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/altv-api-wrapper
• Size: 172 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


    

    
alt:V API Wrapper

    
A NodeJS wrapper for the alt:V API, made with TypeScript.

    
Read the Documentation


[![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/ZackaryH8/altv-api-wrapper.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/ZackaryH8/altv-api-wrapper/context:javascript)

![NPM Version](https://img.shields.io/npm/v/altv-api-wrapper)

![Issues](https://img.shields.io/github/issues/ZackaryH8/altv-api-wrapper)

## Installation

```

npm install altv-api-wrapper

yarn add altv-api-wrapper

```

## Contribute

There are many ways to contribute to this repo.

* [Submit bugs](https://github.com/ZackaryH8/altv-api-wrapper/issues) and help us verify fixes as they are checked in.

* Review the [source code changes](https://github.com/ZackaryH8/altv-api-wrapper/pulls).

## Example Usage

### Get Server By Host

#### Callback

```js

import { Masterlist } from 'altv-api-wrapper';

const masterlist = new Masterlist()

masterlist.getServerByHost('xxxx').then((result) => {

    console.log(result)

})

```

#### Async... await

```js

import { Masterlist } from 'altv-api-wrapper';

const masterlist = new Masterlist()

async function getServerByHost() {

    const server = await masterlist.getServerByHost('xxxx');

    console.log(server)

}

```

## Disclaimer

This repository is not affiliated, associated, authorized, endorsed by, or in any way officially connected with alt:V, or the alt:MP team.