https://github.com/hell-sh/apimon-js
Get Apimon's power in Javascript without a hassle.
https://github.com/hell-sh/apimon-js
api apimon client client-library http javascript-library
Last synced: about 1 month ago
JSON representation
Get Apimon's power in Javascript without a hassle.
- Host: GitHub
- URL: https://github.com/hell-sh/apimon-js
- Owner: hell-sh
- License: mit
- Created: 2019-01-09T04:08:34.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-25T11:23:56.000Z (about 7 years ago)
- Last Synced: 2025-08-19T11:02:48.661Z (7 months ago)
- Topics: api, apimon, client, client-library, http, javascript-library
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/apimon
- Size: 52.7 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# apimon-js
Get [Apimon](https://apimon.de/)'s power in Javascript without a hassle.
- [Examples](https://github.com/hell-sh/apimon-js/tree/master/examples)
## For Websites
[Need SRI?](https://cdn.hell.sh/#apimon-js)
## Usage
When using nodejs, you can simply use `npm i apimon` and then `const apimon = require("apimon");`, but you can also run `npm -g i apimon` to have global access to the `apimon` CLI utility, which you might like.
Regardless of NPM or `` tag, you will have access to the `apimon` object which has a function for [every Apimon HTTP API](https://apimon.de/http-apis) except for "Generate QR Code," e.g. `https://apimon.de/ip/arg` = `apimon.ip(arg)`.
The "My IP Address" endpoints are accessible using `apimon.myip()`, `.myipv4()`, and `.myipv6()`.
All of these functions will return a Promise, which, if resolved, will provide you with an object corresponding to the JSON object or plain text that Apimon has returned; however, some objects will have additional values provided exclusively by apimon-js:
- **country**
- `.english_name` - alias for `.name.EN`
- `.native_name` - alias for `.name[.language.code]`
- **mcuser**
- `.initial_name` - alias for `.history[0].name`
- `.full_id` - `.id` but with dashes
Instead of `apimon.`, you can also use `apimon.hi.` to get a humanly-readable `\n`-terminated string in response to these functions. Additionally, `apimon.hi.` also exposes `ASforHumans`, `countryForHumans`, and `contactForHumans` so you can turn AS, country, and WHOIS contact objects into humanly-readable `\n`-terminated strings, respectively.
If an error occured, the Promise will be rejected with the HTTP error code or 0 in the case of a network error. See [Error Handling](https://apimon.de/http-apis#errors) for information on what HTTP error codes mean.
`apimon.hi` also exposes the `errors` object which contains the meanings of some reject codes in English.