# hytale-api-sdk

> Hytale API SDK

Latest version **1.0.3** (published 2019-04-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install hytale-api-sdk
pnpm add hytale-api-sdk
yarn add hytale-api-sdk
bun add hytale-api-sdk
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2019-04-26 |
| First published | 2019-04-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 66.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | sdieunidou |

## Links

- npm: https://www.npmjs.com/package/hytale-api-sdk
- Repository: https://github.com/mTxServ/hytale-api-sdk-js
- Homepage: https://hytale.game
- Issues: https://github.com/mTxServ/hytale-api-sdk-js/issues
- npm.io page: https://npm.io/package/hytale-api-sdk

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) 3.7.0

## Recent versions

- 1.0.3 (latest) — 2019-04-26
- 1.0.2 — 2019-04-26
- 1.0.1 — 2019-04-26
- 1.0.0 — 2019-04-26

## README

# Hytale API - Javascript SDK

Hytale Api - JavaScript client for Hytale Official API

For more information, please visit [https://hytale.game](https://hytale.game)

## Installation

### For [Node.js](https://nodejs.org/)

#### npm

Then install it via:

```shell
npm install hytale-api-sdk --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
the above steps with Node.js and installing browserify with `npm install -g browserify`,
perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually 
use this library):

```shell
browserify main.js > bundle.js
```

Then include *bundle.js* in the HTML pages.

### Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error:
Cannot resolve module", most certainly you should disable AMD loader. Add/merge
the following section to your webpack config:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
var HytaleApi = require('hytale-api-sdk');
 
var api = new HytaleApi.ArticlesApi();
 
var slug = "creating-creature-sounds-for-hytale"; // {String} Slug of article
 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully');
    console.log(data);
  }
};
 
api.getArticleBySlug(slug, callback);
```

## Documentation for API Endpoints

All URIs are relative to *https://hytale.com/api*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*HytaleApi.ArticlesApi* | [**getArticleBySlug**](docs/ArticlesApi.md#getArticleBySlug) | **GET** /blog/post/slug/{slug} | 
*HytaleApi.ArticlesApi* | [**getArticles**](docs/ArticlesApi.md#getArticles) | **GET** /blog/post/published | 
*HytaleApi.ArticlesApi* | [**getArticlesOfMonthAndYear**](docs/ArticlesApi.md#getArticlesOfMonthAndYear) | **GET** /blog/post/archive/{year}/{month}/ | 
*HytaleApi.JobsApi* | [**getJobs**](docs/JobsApi.md#getJobs) | **GET** /job/listing | 


## Documentation for Models

 - [HytaleApi.Article](docs/Article.md)
 - [HytaleApi.CoverImage](docs/CoverImage.md)
 - [HytaleApi.Job](docs/Job.md)


## Documentation for Authorization

 All endpoints do not require authorization.

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