Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 

apimon-js

Get Apimon's power in Javascript without a hassle.

For Websites

<script src="https://cdn.hell.sh/apimon-js/latest/apimon.js" crossorigin="anonymous"></script>

Need SRI?

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 <script> tag, you will have access to the apimon object which has a function for every Apimon HTTP API 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 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.

About

Get Apimon's power in Javascript without a hassle.

Topics

Resources

License

Releases

No releases published

Packages

No packages published