Skip to main content
NPM Registry logo

Overview

Add NPM Registry to any ModuleX agent or workflow. Read-only access to the public npm registry: package info, search, popular packages, version history, dependency graphs, and download statistics.
Categories: Developer Tools & Infrastructure · Coding · Package Management · Developer Tools · Auth: API Key · Actions: 6

Authentication

API Key Authentication

Optional authentication for private npm registries. Leave empty for public npm registry access.

Required Credentials

FieldDescriptionRequiredFormat
NPM API KeyYour npm authentication token (optional for public registry)No-

Available Actions

Parameters

package_name
string
required
The name of the npm package to look up

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "version": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Version"
    },
    "description": {
      "default": "",
      "title": "Description",
      "type": "string"
    },
    "author": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Author"
    },
    "homepage": {
      "default": "",
      "title": "Homepage",
      "type": "string"
    },
    "repository": {
      "default": "",
      "title": "Repository",
      "type": "string"
    },
    "license": {
      "default": "",
      "title": "License",
      "type": "string"
    },
    "keywords": {
      "items": {
        "type": "string"
      },
      "title": "Keywords",
      "type": "array"
    },
    "dependencies": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Dependencies",
      "type": "object"
    },
    "devDependencies": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Devdependencies",
      "type": "object"
    },
    "peerDependencies": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Peerdependencies",
      "type": "object"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetPackageInfoOutput",
  "type": "object"
}

Parameters

query
string
required
Search query text
size
integer
Number of results to return (1-250) (Default: 10)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "total": {
      "default": 0,
      "title": "Total",
      "type": "integer"
    },
    "packages": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Packages",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "SearchPackagesOutput",
  "type": "object"
}

Parameters

package_name
string
required
The name of the npm package

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "dist_tags": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Dist Tags",
      "type": "object"
    },
    "versions": {
      "items": {
        "additionalProperties": {
          "type": "string"
        },
        "type": "object"
      },
      "title": "Versions",
      "type": "array"
    },
    "total_versions": {
      "default": 0,
      "title": "Total Versions",
      "type": "integer"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetPackageVersionsOutput",
  "type": "object"
}

Parameters

package_name
string
required
The name of the npm package
version
string
Specific version (defaults to latest)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Name"
    },
    "version": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Version"
    },
    "dependencies": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Dependencies",
      "type": "object"
    },
    "devDependencies": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Devdependencies",
      "type": "object"
    },
    "peerDependencies": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Peerdependencies",
      "type": "object"
    },
    "optionalDependencies": {
      "additionalProperties": {
        "type": "string"
      },
      "title": "Optionaldependencies",
      "type": "object"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetPackageDependenciesOutput",
  "type": "object"
}

Parameters

package_name
string
required
The name of the npm package
period
string
Time period for download statistics (Default: last-week)

Response

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "title": "Success",
      "type": "boolean"
    },
    "error": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Error"
    },
    "package": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Package"
    },
    "period": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Period"
    },
    "start": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "Start"
    },
    "end": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "title": "End"
    },
    "total_downloads": {
      "default": 0,
      "title": "Total Downloads",
      "type": "integer"
    },
    "daily_downloads": {
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "title": "Daily Downloads",
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "title": "GetPackageDownloadStatsOutput",
  "type": "object"
}

Limits & Quotas

  • npm’s public registry has loose, unenforced limits — be reasonable. Two API hosts are involved: registry.npmjs.org (metadata) and api.npmjs.org (downloads).
  • period must be one of last-day, last-week, last-month, last-year (validated client-side; otherwise success=False).
  • Search size is clamped to [1, 250].

Algolia

Amazon Web Services

Apify