getmyip-pro 0.1.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Soos Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,60 @@
+# getmyip-pro (Node.js)
+
+Tiny, dependency-free Node.js client **and CLI** for the [getmyip.pro](https://getmyip.pro) IP geolocation API — privacy-first (no logs, no trackers), with ip-api-compatible JSON.
+
+> One plan: free. 60 requests/min, 10,000/day, batch up to 100 IPs — no signup,
+> no key. Hit the ceiling? Email tech@getmyip.pro and we'll raise it for you.
+
+[![Test](https://github.com/soos-labs/getmyip-js/actions/workflows/test.yml/badge.svg)](https://github.com/soos-labs/getmyip-js/actions/workflows/test.yml)
+[![npm](https://img.shields.io/npm/v/getmyip-pro)](https://www.npmjs.com/package/getmyip-pro)
+![License: MIT](https://img.shields.io/badge/license-MIT-blue)
+
+## CLI
+
+```sh
+npm install -g getmyip-pro   # или npx getmyip-pro
+```
+
+```console
+$ getmyip
+IP:       45.82.64.40
+Location: Naaldwijk, Netherlands (NL)
+Network:  WorldStream B.V. (AS49981)
+Timezone: Europe/Amsterdam
+
+$ getmyip 8.8.8.8
+IP:       8.8.8.8
+Location: United States (US)
+Network:  Google LLC (AS15169)
+
+$ getmyip --field org 8.8.8.8
+Google LLC
+
+$ getmyip --json 8.8.8.8
+{"ip":"8.8.8.8","country":"United States",...}
+```
+
+An API key is optional (the anonymous tier needs none); pass `--key` or set `GETMYIP_API_KEY` for higher limits. Point the CLI at a self-hosted instance with `GETMYIP_BASE_URL`.
+
+## Library
+
+```js
+import { Client } from "getmyip-pro";
+
+const c = new Client();                    // new Client({ apiKey: "..." }) to raise limits
+const me = await c.me();                   // your own IP
+const r = await c.lookup("8.8.8.8");       // any IPv4/IPv6
+const rs = await c.batch(["8.8.8.8", "1.1.1.1"]);
+
+console.log(r.country, r.org, r.asn);      // United States Google LLC 15169
+```
+
+Errors throw `APIError` with `.status` and `.error` (e.g. `rate_limited` — see [limits](https://getmyip.pro/limits)).
+
+No dependencies: built-in `fetch` only. Node 18+.
+
+## Related
+
+- Go client/CLI: [soos-labs/getmyip-go](https://github.com/soos-labs/getmyip-go)
+- Python client/CLI: [soos-labs/getmyip-python](https://github.com/soos-labs/getmyip-python)
+- API docs: [docs.getmyip.pro](https://docs.getmyip.pro)

package/cli.js

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+// CLI: `getmyip [--json] [--field name] [--key KEY] [ip]` — как у getmyip-go.
+
+import { APIError, Client } from "./index.js";
+
+function usage() {
+  console.error("usage: getmyip [--json] [--field name] [--key KEY] [ip]");
+  process.exit(2);
+}
+
+const args = process.argv.slice(2);
+let ip, json = false, field, key = process.env.GETMYIP_API_KEY ?? "";
+for (let i = 0; i < args.length; i++) {
+  const a = args[i];
+  if (a === "--json" || a === "-json") json = true;
+  else if (a === "--field" || a === "-field") field = args[++i] ?? usage();
+  else if (a === "--key" || a === "-key") key = args[++i] ?? usage();
+  else if (a === "--help" || a === "-h") usage();
+  else if (a.startsWith("-")) usage();
+  else if (ip === undefined) ip = a;
+  else usage();
+}
+
+try {
+  // GETMYIP_BASE_URL — свой инстанс (self-hosted) или мок в тестах
+  const c = new Client({ apiKey: key, baseUrl: process.env.GETMYIP_BASE_URL || undefined });
+  const r = ip ? await c.lookup(ip) : await c.me();
+  if (field !== undefined) {
+    if (!(field in r)) {
+      console.error(`getmyip: unknown field '${field}'`);
+      process.exit(1);
+    }
+    console.log(r[field]);
+  } else if (json) {
+    console.log(JSON.stringify(r));
+  } else {
+    console.log(`IP:       ${r.ip}`);
+    const loc = [r.city, r.country].filter(Boolean).join(", ");
+    if (loc) console.log(`Location: ${loc} (${r.country_code})`);
+    if (r.org) console.log(`Network:  ${r.org}${r.asn ? ` (AS${r.asn})` : ""}`);
+    if (r.timezone) console.log(`Timezone: ${r.timezone}`);
+  }
+} catch (e) {
+  console.error(`getmyip: ${e instanceof APIError ? e.error || e.status : e.message}`);
+  process.exit(1);
+}

package/index.d.ts

@@ -0,0 +1,52 @@
+export declare const DEFAULT_BASE_URL: string;
+export declare const VERSION: string;
+
+/** A single geolocation lookup response (ip-api-compatible field set). */
+export interface Result {
+  ip: string;
+  ip_version: number;
+  is_private: boolean;
+  country_code: string;
+  country: string;
+  region: string;
+  city: string;
+  postal: string;
+  latitude: number;
+  longitude: number;
+  timezone: string;
+  asn: number;
+  org: string;
+  hostname?: string;
+  /** поля, которых клиент ещё не знает, приходят как есть */
+  [extra: string]: unknown;
+}
+
+/** Non-200 API response; carries HTTP status and the API's error code. */
+export declare class APIError extends Error {
+  status: number;
+  error: string;
+  constructor(status: number, error?: string);
+}
+
+export interface ClientOptions {
+  /** Optional — the free anonymous tier needs no key; a key raises rate limits. */
+  apiKey?: string;
+  baseUrl?: string;
+  timeoutMs?: number;
+}
+
+/** Talks to the getmyip API. */
+export declare class Client {
+  apiKey: string;
+  baseUrl: string;
+  timeoutMs: number;
+  constructor(opts?: ClientOptions);
+  /** Geolocation for the caller's own public IP. */
+  me(): Promise<Result>;
+  /** Geolocation for the given IPv4 or IPv6 address. */
+  lookup(ip: string): Promise<Result>;
+  /** Look up many addresses in a single request. */
+  batch(ips: string[]): Promise<Result[]>;
+}
+
+export default Client;

package/index.js

@@ -0,0 +1,71 @@
+// Tiny, dependency-free Node.js client for the getmyip.pro IP geolocation API —
+// privacy-first (no logs, no trackers), ip-api-compatible JSON.
+// See https://getmyip.pro/docs (API at https://api.getmyip.pro). Node 18+ (fetch).
+
+export const DEFAULT_BASE_URL = "https://api.getmyip.pro";
+export const VERSION = "0.1.2";
+
+/** Non-200 API response; carries HTTP status and the API's error code. */
+export class APIError extends Error {
+  constructor(status, error = "") {
+    super(`getmyip: ${error || "unexpected status"} (status ${status})`);
+    this.name = "APIError";
+    this.status = status;
+    this.error = error;
+  }
+}
+
+/**
+ * Talks to the getmyip API. An API key is optional — the free anonymous tier
+ * needs none; a key (X-API-Key) raises rate limits.
+ */
+export class Client {
+  /** @param {{apiKey?: string, baseUrl?: string, timeoutMs?: number}} [opts] */
+  constructor({ apiKey = "", baseUrl = DEFAULT_BASE_URL, timeoutMs = 10_000 } = {}) {
+    this.apiKey = apiKey;
+    this.baseUrl = baseUrl.replace(/\/+$/, "");
+    this.timeoutMs = timeoutMs;
+  }
+
+  /** Geolocation for the caller's own public IP. */
+  me() {
+    return this.#request("GET", "/v1/json");
+  }
+
+  /** Geolocation for the given IPv4 or IPv6 address. */
+  lookup(ip) {
+    return this.#request("GET", "/v1/" + encodeURIComponent(ip));
+  }
+
+  /** Look up many addresses in a single request. */
+  async batch(ips) {
+    const out = await this.#request("POST", "/v1/batch", { ips });
+    return out.results ?? [];
+  }
+
+  async #request(method, path, body) {
+    const headers = {
+      Accept: "application/json",
+      // дефолтные UA скриптов режутся ботозащитой edge — представляемся собой
+      "User-Agent": `getmyip-pro-js/${VERSION}`,
+    };
+    if (body !== undefined) headers["Content-Type"] = "application/json";
+    if (this.apiKey) headers["X-API-Key"] = this.apiKey;
+    const res = await fetch(this.baseUrl + path, {
+      method,
+      headers,
+      body: body === undefined ? undefined : JSON.stringify(body),
+      signal: AbortSignal.timeout(this.timeoutMs),
+    });
+    if (!res.ok) {
+      let err = "";
+      try {
+        err = (await res.json()).error ?? "";
+      } catch {}
+      throw new APIError(res.status, err);
+    }
+    return res.json();
+  }
+}
+
+export default Client;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "getmyip-pro",
+  "version": "0.1.2",
+  "description": "Tiny, dependency-free Node.js client and CLI for the getmyip.pro IP geolocation API",
+  "type": "module",
+  "main": "index.js",
+  "exports": "./index.js",
+  "bin": {
+    "getmyip": "./cli.js"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "cli.js",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "node --test"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "keywords": [
+    "ip",
+    "geolocation",
+    "geoip",
+    "asn",
+    "ip-api"
+  ],
+  "author": "Soos Labs",
+  "license": "MIT",
+  "homepage": "https://getmyip.pro",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/soos-labs/getmyip-js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/soos-labs/getmyip-js/issues"
+  },
+  "types": "./index.d.ts"
+}