A Node.js API for Natlas

📝 Table of Contents

• About
• Getting Started
• Usage
• Built Using

🧐 About

NatlasAPI is a Node.js API that parses page content and retrieves data from the given page in a object oriented format.

Prerequisites

You will require NPM and NodeJS 14+

Debian / Ubuntu

# apt install npm nodejs -y

Installing

Simply install via the node package manager (NPM).

$ npm install natlas-api

🎈 Usage

Example.js

const natlasAPI = require("../src/natlas.js");
const natlas = new natlasAPI("URL TO A NATLAS SERVER");
(async function () {
  console.log(await natlas.getPage(1));
})();

⛏️ Built Using

• NodeJs - Server Environment

Known Natlas Servers

Since Natlas is a self-hosted open-source server and not a single central entity.

I have compiled a list of 2 Natlas servers

• https://ntls.skyn3t.in
  • Ratelimits requests to delay atleast 750ms
  • When being ratelimited you will recieve a '503' status error.
• https://natlas.io/
  • Ratelimits unknown.

Adding discovered Natlas servers

Email hash(@)skyn3t.in or create a PR on the git repository.

Notes

• I am looking for someone to write a better README.md!
  • Create a PR on the github repository or email hash(@)skyn3t.in