{"id":13583338,"url":"https://github.com/alxhotel/nat-api","last_synced_at":"2025-09-13T15:32:23.533Z","repository":{"id":36949759,"uuid":"214917763","full_name":"alxhotel/nat-api","owner":"alxhotel","description":":left_right_arrow: Fast port mapping with UPnP and NAT-PMP","archived":false,"fork":false,"pushed_at":"2023-07-04T15:46:26.000Z","size":106,"stargazers_count":23,"open_issues_count":12,"forks_count":13,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-19T14:44:04.875Z","etag":null,"topics":["api","js","nat","pmp","protocol","upnp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/alxhotel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-10-14T00:55:16.000Z","updated_at":"2024-02-20T01:09:22.000Z","dependencies_parsed_at":"2024-04-08T18:06:42.382Z","dependency_job_id":null,"html_url":"https://github.com/alxhotel/nat-api","commit_stats":{"total_commits":44,"total_committers":6,"mean_commits":7.333333333333333,"dds":"0.34090909090909094","last_synced_commit":"16fd1e4b86216dc0ec46acea4c82d9bdf03aab65"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxhotel%2Fnat-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxhotel%2Fnat-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxhotel%2Fnat-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alxhotel%2Fnat-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alxhotel","download_url":"https://codeload.github.com/alxhotel/nat-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232889163,"owners_count":18592314,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","js","nat","pmp","protocol","upnp"],"created_at":"2024-08-01T15:03:24.690Z","updated_at":"2025-01-07T13:48:14.997Z","avatar_url":"https://github.com/alxhotel.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# nat-api\n\n[![NPM Version][nat-api-ni]][nat-api-nu]\n[![Build Status][nat-api-bi]][nat-api-bu]\n[![Dependency Status][nat-api-di]][nat-api-du]\n[![Standard - Javascript Style Guide][standard-image]][standard-url]\n\nFast port mapping with **UPnP** and **NAT-PMP** in NodeJS.\n\n## Install\n\n**Required: NodeJS \u003e= 10**\n\n```sh\nnpm install nat-api\n```\n\n## Usage\n\n```js\nconst NatAPI = require('nat-api')\n\nconst client = new NatAPI()\n\n// Map public port 1000 to private port 1000 with UDP and TCP\nclient.map(1000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Map public port 2000 to private port 3000 with UDP and TCP\nclient.map(2000, 3000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Map public port 4000 to private port 5000 with only UDP\nclient.map({ publicPort: 4000, privatePort: 5000, ttl: 1800, protocol: 'UDP' }, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port mapped!')\n})\n\n// Unmap port public and private port 1000 with UDP and TCP\nclient.unmap(1000, function (err) {\n  if (err) return console.log('Error', err)\n  console.log('Port unmapped!') \n})\n\n// Get external IP\nclient.externalIp(function(err, ip) {\n  if (err) return console.log('Error', err)\n  console.log('External IP:', ip)\n})\n\n// Destroy object\nclient.destroy()\n```\n\n## API\n\n### `client = new NatAPI([opts])`\n\nCreate a new `nat-api` instance.\n\nIf `opts` is specified, then the default options (shown below) will be overridden.\n\n```js\n{\n  ttl: 1200, // Time to live of each port mapping in seconds (default: 1200)\n  autoUpdate: true, // Refresh all the port mapping to keep them from expiring (default: true)\n  gateway: '192.168.1.1', // Default gateway (default: null)\n  enablePMP: false // Enable PMP (default: false)\n}\n```\n\nIf `gateway` is not set, then `nat-api` will get the default gateway based on the current network interface.\n\n### `client.map(port, [callback])`\n* `port`: Public and private ports\n* `callback`\n\nThis method will use `port` por mapping the public port to the same private port.\n\nIt uses the default TTL and creates a map for UDP and TCP.\n\n### `client.map(publicPort, privatePort, [callback])`\n* `publicPort`: Public port\n* `privatePort`: Private port\n* `callback`\n\nThis is another quick way of mapping `publciPort` to `privatePort` with any protocol (UDP and TCP).\n\n### `client.map(opts, [callback])`\n* `opts`:\n - `publicPort`: Public port\n - `privatePort`: Private port\n - `protocol`: Port protocol (`UDP`, `TCP` or `null` for both)\n - `ttl`: Overwrite the default TTL in seconds.\n - `description`: Description of the port mapping\n* `callback`\n\n### `client.unmap(port, [callback])`\n\nUnmap any port that has the public port or private port equal to `port`.\n\n### `client.unmap(publicPort, privatePort, [callback])`\n\nUnmap any port that has the public port or private port equal to `publicPort` and `privatePort`, respectively.\n\n### `client.unmap(opts, [callback])`\n\nUnmap any port that contains the parameters provided in `opts`.\n\n### `client.externalIp([callback])`\n* `callback(err, ip)`\n\nGet the external IP address.\n\n### `client.destroy([callback])`\n\nDestroy the client. Unmaps all the ports open with `nat-api` and cleans up large data structure resources.\n\n## Additional Information\n\n- http://miniupnp.free.fr/nat-pmp.html\n- http://wikipedia.org/wiki/NAT_Port_Mapping_Protocol\n- http://tools.ietf.org/html/draft-cheshire-nat-pmp-03\n\n\n## License\n\nMIT. Copyright (c) [Alex](https://github.com/alxhotel)\n\n[nat-api-ni]: https://img.shields.io/npm/v/nat-api.svg\n[nat-api-nu]: https://npmjs.org/package/nat-api\n[nat-api-bi]: https://img.shields.io/github/actions/workflow/status/alxhotel/nat-api/ci.yml?branch=master\n[nat-api-bu]: https://github.com/alxhotel/nat-api/actions\n[nat-api-di]: https://img.shields.io/librariesio/release/npm/nat-api\n[nat-api-du]: https://libraries.io/npm/nat-api\n[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg\n[standard-url]: https://standardjs.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falxhotel%2Fnat-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falxhotel%2Fnat-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falxhotel%2Fnat-api/lists"}