Repository files navigation

JavaScript SDK forSocket.dev API - Security analysis, vulnerability scanning, and compliance monitoring for software supply chains.

• Installation
• Quick Start
• API Methods -Full API Reference
• Documentation
• Examples

Requirements: Node.js 18+ ·ESM only (v2.0+)

pnpm add @socketsecurity/sdk

Note: Version 2.0+ is ESM-only. For CommonJS support, use version 1.x.

import{SocketSdk}from'@socketsecurity/sdk'constclient=newSocketSdk('your-api-key',{retries:3,// Retry failed requests up to 3 timesretryDelay:1000,// Start with 1s delay, exponential backofftimeout:30000,// 30 second timeout})// Check your quotaconstquota=awaitclient.getQuota()if(quota.success){console.log(`Available quota:${quota.data.quota} units`)}// Analyze a packageconstresult=awaitclient.getScoreByNpmPackage('express','4.18.0')if(result.success){console.log(`Security Score:${result.data.score}/100`)}// Batch analyze multiple packagesconstbatchResult=awaitclient.batchPackageFetch({components:[{purl:'pkg:npm/express@4.18.0'},{purl:'pkg:npm/react@18.0.0'}]})

→ Configuration

Quick security checks:batchPackageFetch() ·batchPackageStream() ·getIssuesByNpmPackage() ·getScoreByNpmPackage()

→ Documentation

Project scanning:createDependenciesSnapshot() ·createOrgFullScan() ·createScanFromFilepaths() ·getScan() ·getScanList() ·getSupportedScanFiles()

→ Documentation

Organizations and repositories:getOrganizations() ·createOrgRepo() ·getOrgRepo() ·getOrgRepoList() ·updateOrgRepo() ·deleteOrgRepo()

→ Documentation

Security configuration:getOrgSecurityPolicy() ·updateOrgSecurityPolicy() ·getOrgLicensePolicy() ·updateOrgLicensePolicy() ·postSettings()

→ Documentation

Deep analysis:getOrgFullScanList() ·getOrgFullScanMetadata() ·getOrgFullScanBuffered() ·streamOrgFullScan() ·deleteOrgFullScan()

→ Documentation

Scan comparison:createOrgDiffScanFromIds() ·getDiffScanById() ·listOrgDiffScans() ·deleteOrgDiffScan()

→ Documentation

Security fixes:streamPatchesFromScan() ·viewPatch()

→ Documentation

Alert management:getOrgTriage() ·updateOrgAlertTriage()

→ Documentation

SBOM export:exportCDX() ·exportSPDX() ·searchDependencies() ·uploadManifestFiles()

→ Documentation

Categorization:createOrgRepoLabel() ·getOrgRepoLabel() ·getOrgRepoLabelList() ·updateOrgRepoLabel() ·deleteOrgRepoLabel()

→ Documentation

Usage metrics:getQuota() ·getOrgAnalytics() ·getRepoAnalytics() ·getAuditLogEvents()

→ Documentation

API tokens:getAPITokens() ·postAPIToken() ·postAPITokensRotate() ·postAPITokensRevoke() ·postAPITokenUpdate()

→ Documentation

Feature access:getEnabledEntitlements() ·getEntitlements()

→ Documentation

Cost helpers:getQuotaCost() ·getRequiredPermissions() ·calculateTotalQuotaCost() ·hasQuotaForMethods() ·getMethodsByQuotaCost() ·getMethodsByPermissions() ·getQuotaUsageSummary() ·getAllMethodRequirements()

→ Documentation

Raw API access:getApi() ·sendApi()

→ Documentation

Seeusage-examples.md for complete examples including:

• Package security analysis
• Batch operations
• Full scans with SBOM
• Policy management
• Quota planning

MIT