100 크레딧 무료, 카드 등록 없이지금 시작하기
Logo
npm logonpm API

npm 패키지 데이터 API

SocialCrawl API 키로 npm을 검색하고 패키지 버전별 의존성, 라이선스, 관리자, 다운로드 수, tarball 무결성 해시를 구조화 JSON으로 가져옵니다. 호출은 크레딧으로 과금됩니다.

npm logo
/v1/npm

활성 엔드포인트는 2개입니다. 패키지 검색과 패키지 버전 상세를 지원합니다.

  • GET /v1/npm/search
  • GET /v1/npm/package

npm 엔드포인트

공개 npm 레지스트리를 읽는 엔드포인트는 2개입니다. 패키지를 검색한 뒤 버전 하나를 전체로 읽습니다.

패키지 검색

1 크레딧
/v1/npm/search

검색어와 npm 한정자에 맞는 패키지를 반환하며, 각 패키지의 이름, 최신 버전, 설명, 라이선스, 링크, 키워드, 사용자 이름 기준 관리자, 주간과 월간 다운로드 수, 의존 패키지 수가 포함됩니다. 페이지당 최대 100개, 100페이지까지 npm의 전체 결과 수와 함께 조회합니다. 표준 티어(1 크레딧)입니다.

query, page, limit

패키지 버전

1 크레딧
/v1/npm/package

이름이나 링크로 패키지 버전 하나를 반환하며 기본값은 최신 버전입니다. 설명, 라이선스, 홈페이지, 저장소, 사용자 이름 기준 관리자, 의존성, peer 의존성, 엔진, 무결성 해시가 담긴 tarball 링크가 포함됩니다. npm에 없는 패키지나 버전은 404를 반환하며 과금되지 않습니다. 표준 티어(1 크레딧)입니다.

package or url, version

npm Registry API2개 엔드포인트 지원
문서 보기
Packages

검색어와 일치하는 npm 패키지를 찾아 각 패키지의 최신 버전, 설명, 라이선스, 링크, 다운로드 수, 의존 패키지 수를 반환합니다.

작업에 맞는 라이브러리를 찾거나 채택 정도를 비교하고 생태계의 패키지를 추적할 때 사용하세요.

1크레딧

GET/v1/npm/search?query=react+state

query · Search terms, 1 to 300 characters, for example react state, with npm qualifiers such as keywords:hooks.

$ curl https://www.socialcrawl.dev/v1/npm/search?query=react+state \
    -H "x-api-key: sc_YOUR_API_KEY"
대기 중
// 실제 실행에는 API 키가 필요합니다. "실행해보기"를 누르면 예시 응답을 표시합니다

npm API 동작

npm도 SocialCrawl의 일반 데이터 표면입니다. API 키로 GET /v1/npm/…를 호출하고, 실시간 조회에만 크레딧을 쓰며, 하나의 JSON 응답 형식을 받습니다.

호출 인증

x-api-key 헤더에 키를 보냅니다. 공개 읽기에 npm 계정은 필요 없습니다. SocialCrawl 전 플랫폼에 같은 키를 사용합니다.

쿼리 파라미터로 GET 호출

검색은 query, page, limit을 받습니다. 패키지는 package나 url과 version을 받습니다. 과금 전에 형식을 검증합니다.

좌석이 아닌 크레딧 과금

모든 npm 경로는 1 크레딧입니다. 캐시 적중은 0 크레딧입니다.

하나의 JSON 응답 형식

모든 응답은 success, data, credits_used, credits_remaining, request_id, cached로 같은 형태입니다. 페이지가 있는 경로의 목록에는 pagination이 함께 담깁니다.

일반적인 연동 흐름

대부분 제품은 필요한 기능을 한 번 검색한 뒤 의존하는 버전을 읽습니다.

01패키지 검색
GET /v1/npm/search?query=…

버전, 다운로드 수, 의존 패키지 수가 담긴 패키지 PostList

선택하기 전에 채택 정도로 후보를 비교합니다.

02버전 읽기
GET /v1/npm/package?package=…

의존성, 엔진, tarball 해시가 담긴 Post

한 번의 호출로 버전이 가져오는 패키지를 확인합니다.

03다른 버전 읽기
GET /v1/npm/package?package=…&version=…

고정 버전이나 태그의 Post

업그레이드 전에 바뀐 내용을 확인합니다.

요청
GET /v1/npm/search?query=react+state
Host: www.socialcrawl.dev
x-api-key: sc_your_api_key_here

GET /v1/npm/package?package=zod
응답 봉투
{
  "success": true,
  "data": {
    "post": {
      "id": "zod",
      "url": "https://www.npmjs.com/package/zod",
      "content": { "text": "TypeScript-first schema declaration and validation library with static type inference" },
      "ext": {
        "title": "zod",
        "npm": { "version": "4.6.7", "license": "MIT", "maintainers": ["colinhacks"] }
      }
    }
  },
  "credits_used": 1,
  "credits_remaining": 9999,
  "request_id": "req_…",
  "cached": false
}

data에 담기는 내용

아키타입이 같으면 필드 이름도 SocialCrawl 전체와 같습니다. 한 번 파싱해 모든 플랫폼에 재사용합니다.

PostListsearch

items[]에 post.id(이름), ext.title, url, content.text(설명), ext.npm version, downloads_weekly, dependents

Postpackage

ext.npm dependencies, peer_dependencies, engines, tarball_url, integrity가 담긴 버전

게이트웨이 내부 처리

다른 /v1 플랫폼 엔드포인트와 같은 요청 수명 주기를 따릅니다. npm는 별도 부가 기능이 아닙니다.

  1. 01

    엣지에서 호출 수신

    Next.js catch-all 경로가 Hono social API로 전달합니다. request_id를 발급하고 키를 인증한 뒤 속도 제한(분당 600회)과 동시성(키당 50건)을 적용합니다.

  2. 02

    검증 후 차감

    레지스트리에서 npm 경로를 찾습니다. 필수 파라미터와 형식 검사를 먼저 실행합니다. 잘못된 입력은 과금 없이 400을 반환합니다. 유효한 호출은 조회 전에 티어 비용을 원자적으로 차감합니다.

  3. 03

    캐시 또는 조회

    platform, resource, params로 결정적 캐시 키를 만듭니다. 적중하면 즉시 반환하고 credits_used는 0입니다. 미스이면 공개 데이터를 실시간으로 읽으며, 5xx나 네트워크 오류는 재시도하고 소스가 불안정하면 서킷 브레이커가 작동합니다.

  4. 04

    정규화 후 반환

    npm 데이터를 Post와 PostList 아키타입으로 매핑하고 npm 고유 정보는 ext.npm에 담아 검증한 뒤, 성공 응답으로 감싸 과금 감사용으로 기록합니다.

운영에서 중요한 과금 규칙

  • search, package: 1 크레딧
  • 캐시 적중: 0 크레딧
  • 빈 결과나 실패: 자동 환불
  • 잘못된 파라미터: 400, 과금 없음
  • 크레딧 부족: 402, 과금 없음
  • 없는 패키지나 버전: 404, 과금 없음
  • 페이지당 최대 100개, 100페이지
  • 관리자는 사용자 이름만 제공
  • 게시, 계정 데이터 미지원

npm 데이터 수집 방식

npm 데이터는 공개 데이터입니다. SocialCrawl 스키마로 정규화하므로 별도 공급사 SDK를 익힐 필요가 없습니다.

이 API에서 npm의 의미

npm 레지스트리의 공개 패키지와 게시된 버전, 각 버전의 의존성, 라이선스, 다운로드 수입니다.

SocialCrawl의 수집 방식

공개 데이터를 요청 시 각 소스의 공개 이용 규칙 안에서 읽어 서버에서 정규화합니다.

엣지에서 나가는 데이터

검색은 PostList, 버전은 Post로 공통 형태입니다. npm 고유 정보는 ext.npm에 담깁니다.

실시간으로 제공하지 않는 데이터

게시, 비공개 패키지, 관리자 이메일 주소, 계정 데이터는 제공하지 않습니다.

필드 매핑
name, version, description→ post.*이름, 버전, 설명, 링크
dependencies, engines, licence→ post.ext.npm의존성, 엔진, 라이선스
downloads, dependents, tarball hash→ post.ext.npm다운로드 수, 의존 패키지 수, tarball 해시

이 API의 활용 분야

이 API가 가장 많이 쓰이는 작업입니다.

2active npm endpoints in the registry
1모든 npm 경로의 호출당 크레딧

의존성 조사, 생태계 추적, 공급망 점검

호출하는 쪽은 패키지 분야를 검색한 뒤 의존하는 버전이 바뀔 때 읽습니다. 의존성과 tarball 무결성 해시가 담긴 패키지 버전을 공통 Post 스키마에 담아 카탈로그 전체와 같은 키로 제공합니다.

캐시 미스는 공개 소스를 요청 시 읽습니다. 반복 호출은 캐시에서 0 크레딧으로 처리됩니다.

활용 사례

팀이 이 데이터를 활용하는 대표적인 방식과 주로 쓰는 기술 스택입니다.

의존성 검토

Node, CI 작업

프로젝트가 가져오는 새 버전마다 package를 호출해 라이선스, 엔진, 의존성을 확인합니다.

생태계 추적

Python, 예약 작업

키워드로 search를 주기적으로 호출해 새 패키지와 다운로드 수를 추적합니다.

공급망 점검

Go, 보안 도구

package로 버전의 tarball 무결성 해시를 읽어 설치된 파일과 비교합니다.

npm API 호출 방법

모든 npm 경로는 1 크레딧입니다. 캐시 적중은 무료입니다.

curl "https://www.socialcrawl.dev/v1/npm/search?query=react%20state" \
  -H "x-api-key: sc_your_api_key_here"
curl "https://www.socialcrawl.dev/v1/npm/package?package=zod" \
  -H "x-api-key: sc_your_api_key_here"
npm logoSocialCrawl의 npm

카탈로그 전체와 같은 키

엔드포인트

npm Registry API는 어떤 데이터를 돌려주나요

모든 엔드포인트가 같은 응답 구조의 JSON을 보내드려요. 엔드포인트가 해당 지표를 지원하고 계산에 필요한 원본 값이 있을 때만 참여율·콘텐츠 카테고리 같은 계산 필드가 포함돼요.

자주 묻는 질문

자주 묻는 질문

API, 요금제, 기능에 대한 질문과 답변입니다.

문의하기
SocialCrawl npm API는 무엇을 제공하나요?
2개 엔드포인트, Search and Package를 제공해요. npm 패키지를 검색하고 게시된 버전 하나를 의존성과 함께 읽으며, 다른 94개 플랫폼과 같은 통합 JSON으로 와요.
스코프 패키지도 읽을 수 있나요?
네. @vue/server-renderer처럼 전체 이름을 넣거나 패키지의 npm 페이지를 url로 넣으면 돼요.
다운로드 수도 오나요?
네. 검색 결과의 post.ext.npm에 주간과 월간 다운로드 수, 의존 패키지 수가 담겨요.
관리자 이메일 주소도 오나요?
아니요. 관리자는 npm 사용자 이름으로만 와요.
비용은 얼마인가요?
호출마다 1 크레딧이고 캐시 적중은 무료예요. 없는 패키지나 버전은 404로 응답하고 과금되지 않아요. 무료 100 크레딧으로 시작해요.
npm Registry 데이터 스크래핑, 법적으로 괜찮을까요?
SocialCrawl은 누구나 볼 수 있는 공개 npm Registry 데이터만 돌려드리고, 로그인이 필요한 비공개 콘텐츠에는 접근하지 않아요. 다만 실제 적법성은 활용 목적과 국가별 법률에 따라 달라져요. npm Registry 이용약관과 GDPR·CCPA 같은 개인정보 보호 법규를 지키는 책임은 이용자에게 있어요. 이 답변은 일반 안내일 뿐, 법률 자문은 아니에요.
npm Registry 스크래핑 API와 공식 npm Registry API는 뭐가 다른가요?
SocialCrawl은 앱 심사나 승인 대기가 없어요. 가입 직후 x-api-key 하나로 npm Registry 엔드포인트를 바로 호출할 수 있고, 응답은 다른 모든 플랫폼과 같은 통합 스키마로 와요. 요금도 플랫폼별 쿼터 대신 크레딧으로 계산해요. 글 게시 같은 쓰기 작업이 필요하다면 공식 API가 맞아요. SocialCrawl은 읽기 전용 데이터만 다뤄요.

AI에게 SocialCrawl을 물어보세요

npm Registry API 레퍼런스 문서 보기

🤖 AI 에이전트나 LLM이신가요? 이 페이지를 markdown으로 읽어보세요