Skip to content
Scrappa Get API key
npm API 1 credit/request

npm Package

GET https://scrappa.co/api/npm/package?package=lodash

Returns one npm package version: description, license, repository, keywords, author, maintainers, funding, scripts, engines, dependencies, dev, peer and optional dependencies, dist info (tarball, integrity, size, file count), weekly and monthly downloads, the version list with release dates, dist-tags and the readme. Scoped names such as @types/node work. version accepts a version or a dist-tag and defaults to latest. The readme comes from the latest release. A package with a very large history returns packument_truncated=true without the version list. Unknown packages and versions answer 404. Costs 1 credit per successful request.

npm Package 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/npm/package?package=lodash
Auth header
x-api-key
Cost
1 credit/request
package = lodash
Response preview
200 OK
{
    "success": true,
    "data": {
        "name": "lodash",
        "version": "4.17.21",
        "description": "Lodash modular utilities.",
        "license": "MIT",
        "homepage": "https://lodash.com/",
        "repository": {
            "url": "git+https://github.com/lodash/lodash.git",
            "type": "git"
        },
        "bugs": {
            "url": "https://github.com/lodash/lodash/issues"
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

3 optional filters available.

package string Required

Package name, scoped names allowed, e.g. lodash or @types/node.

Example value lodash
version string Optional

Version or dist-tag. Defaults to latest.

Example value example
include_versions boolean Optional

Include the version list, release dates and dist-tags. Defaults to true.

Example value true
include_readme boolean Optional

Include the readme. Defaults to true.

Example value true

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/npm/package?package=lodash",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => [
        "x-api-key: YOUR_API_KEY_HERE"
    ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
PHP
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/npm/package?package=lodash');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/npm/package?package=lodash', options)
    .then(response => {
        if (!response.ok) {
            throw new Error(`HTTP error! status: ${response.status}`);
        }
        return response.text();
    })
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/npm/package?package=lodash',
    headers: {
        x-api-key: 'YOUR_API_KEY_HERE',
    }
};

try {
    const response = await axios(options);
    console.log(response.data);
} catch (error) {
    console.error('Error:', error.message);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/npm/package?package=lodash")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'

request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'

begin
    response = http.request(request)
    puts response.body
rescue => e
    puts "Error: #{e.message}"
end
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/npm/package?package=lodash", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/npm/package?package=lodash', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class ApiExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        Request request = new Request.Builder()
            .url("https://scrappa.co/api/npm/package?package=lodash")
        .addHeader("x-api-key", "YOUR_API_KEY_HERE")
            .build();

        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Error: " + response.code());
            }
        } catch (IOException e) {
            System.out.println("Error: " + e.getMessage());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/npm/package?package=lodash", nil)
    if err != nil {
        fmt.Println("Error creating request:", err)
        return
    }
    req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")

    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("Error making request:", err)
        return
    }
    defer resp.Body.Close()

    body, err := ioutil.ReadAll(resp.Body)
    if err != nil {
        fmt.Println("Error reading response:", err)
        return
    }

    fmt.Println(string(body))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/npm/package?package=lodash"
C#
using System;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main()
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");

        try
        {
            var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/npm/package?package=lodash"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/npm/package?package=lodash',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
use reqwest::Client;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();

    let response = client
        .get("https://scrappa.co/api/npm/package?package=lodash")
        .header("x-api-key", "YOUR_API_KEY_HERE")
        .send()
        .await?;

    println!("{}", response.text().await?);

    Ok(())
}

Response Schema

Example response fields are illustrative; inspect the JSON before integrating.

Example response fields

Scan these fields before integrating.

success data meta
JSON Response
200 OK
{
    "success": true,
    "data": {
        "name": "lodash",
        "version": "4.17.21",
        "description": "Lodash modular utilities.",
        "license": "MIT",
        "homepage": "https://lodash.com/",
        "repository": {
            "url": "git+https://github.com/lodash/lodash.git",
            "type": "git"
        },
        "bugs": {
            "url": "https://github.com/lodash/lodash/issues"
        },
        "keywords": [
            "modules",
            "stdlib"
        ],
        "author": {
            "name": "John-David Dalton",
            "email": "john.david.dalton@gmail.com"
        },
        "contributors": [
            {
                "name": "John-David Dalton",
                "email": "john.david.dalton@gmail.com"
            },
            {
                "name": "Mathias Bynens",
                "email": "mathias@qiwi.be"
            }
        ],
        "maintainers": [
            {
                "name": "mathias",
                "email": "mathias@qiwi.be"
            },
            {
                "name": "jdalton",
                "email": "john.david.dalton@gmail.com"
            }
        ],
        "main": "lodash.js",
        "scripts": {
            "test": "echo \"See https://travis-ci.org/lodash-archive/lodash-cli for testing details.\""
        },
        "dependencies": [],
        "dev_dependencies": [],
        "peer_dependencies": [],
        "optional_dependencies": [],
        "dist": {
            "tarball": "https://registry.npmjs.org/lodash/-/lodash-4.18.1.tgz",
            "shasum": "ff2b66c1f6326d59513de2407bf881439812771c",
            "integrity": "sha512-dMInicTPVE8d1e5otfwmmjlxkZoUpiVLwyeTdUsi/Caj/gfzzblBcCE5sRHV/AsjuCmxWrte2TNGSYuCeCq+0Q==",
            "unpacked_size": 1413741,
            "file_count": 1051
        },
        "downloads": {
            "last_week": 194304902,
            "last_month": 571038333
        },
        "created_at": "2015-02-24T05:53:13.392Z",
        "modified_at": "2026-04-14T14:26:11.557Z",
        "dist_tags": {
            "latest": "3.0.1"
        },
        "versions": [
            {
                "version": "0.1.0",
                "published_at": "2015-02-24T05:53:13.392Z"
            },
            {
                "version": "0.1.1",
                "published_at": "2016-12-07T07:18:01.205Z"
            }
        ]
    },
    "meta": {
        "endpoint_family": "package",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

503

Upstream Unavailable

The source could not be fetched after the attempt budget. Never charged. Safe to retry.

{
    "success": false,
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "The source is temporarily unavailable."
    },
    "meta": {
        "billable": false,
        "retryable": true
    }
}
500

Parser Drift

The source returned a shape this parser does not recognise. The incident is reported. Never charged.

{
    "success": false,
    "error": {
        "code": "PARSER_DRIFT",
        "message": "The source response shape changed unexpectedly. The incident has been reported."
    },
    "meta": {
        "billable": false,
        "retryable": false
    }
}
404

Not Found

The source has no such public resource. Never charged.

{
    "success": false,
    "error": {
        "code": "NOT_FOUND",
        "message": "The source has no such public resource."
    },
    "meta": {
        "billable": false,
        "retryable": false
    }
}
422

Invalid Parameter

A value in this request is invalid or the requested page is out of range. Never charged.

{
    "success": false,
    "error": {
        "code": "INVALID_PARAMETER",
        "message": "A value in this request is invalid. Check the parameters before retrying."
    },
    "meta": {
        "billable": false,
        "retryable": false
    }
}

Generate Code with AI

Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.

Try It Live

Test this endpoint in our interactive playground with real data.