Public API Reference

REST API for programmatic access to PatternStack package intelligence. Requires a Workspace subscription or higher.

Quick Start

Get started with the PatternStack API in minutes

Base URL

https://api.patternstack.ai/v1

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from Dashboard → API Keys

Example Request

curl -X GET "https://api.patternstack.ai/v1/packages/search?q=date&ecosystem=npm" \
  -H "Authorization: Bearer ts_live_xxxx"

Rate Limits & Quotas

Daily quotas reset at midnight UTC

Tier	Search	Compare	AI Insights	Security
Free	-	-	-	-
Premium	500/day	200/day	100/day	50/day
Workspace	100/day	50/day	10/day*	10/day

* Free tier AI Insights returns truncated previews (150 chars). Upgrade to Workspace for full responses.

Endpoints

GET
`/v1/packages/search`

Search packages with trend and health signals

workspace+

Name	Type	Required	Description
`q`	string	Required	Search query
`ecosystem`	string	Optional	Filter by ecosystem (npm, pypi, etc.)
`framework`	string	Optional	Filter by framework context
`limit`	number	Optional	Max results (default: 20, max: 50)

POST
`/v1/packages/compare`

Compare 2-10 packages with relative rankings

workspace+

Name	Type	Required	Description
`packages`	string[]	Required	Array of package names (2-10)
`ecosystem`	string	Optional	Ecosystem context

POST
`/v1/insights/explain`

AI-powered package explanations and recommendations

workspace+

Name	Type	Required	Description
`packages`	string[]	Required	Packages to analyze
`question`	string	Optional	Specific question to answer
`context`	object	Optional	Framework/project context

GET
`/v1/migrations/{package}`

Get migration paths for declining packages

workspace+

Name	Type	Required	Description
`package`	string	Required	Package name (path parameter)
`ecosystem`	string	Optional	Package ecosystem

GET
`/v1/trends`

Trending packages by ecosystem and framework

workspace+

Name	Type	Required	Description
`ecosystem`	string	Required	Ecosystem (npm, pypi, etc.)
`framework`	string	Optional	Filter by framework
`direction`	string	Optional	rising, declining, or all
`limit`	number	Optional	Max results (default: 20)

GET
`/v1/packages/{name}/alternatives`

Find alternatives to a specific package

workspace+

Name	Type	Required	Description
`name`	string	Required	Package name (path parameter)
`ecosystem`	string	Optional	Package ecosystem

POST
`/v1/analyze`

Stateless analysis for CI/CD pipelines

workspace+

Name	Type	Required	Description
`packageJson`	object	Optional	package.json contents
`requirementsTxt`	string	Optional	requirements.txt contents
`goMod`	string	Optional	go.mod contents

POST
`/v1/security/scan`

Vulnerability scanning for dependencies

workspace+

Name	Type	Required	Description
`packageJson`	object	Optional	package.json with dependencies
`requirementsTxt`	string	Optional	Python requirements
`severityFilter`	string	Optional	critical, high, medium, or low

GET
`/v1/stack/defaults`

Get canonical industry-standard stack for a framework (agent-optimized)

free+

Name	Type	Required	Description
`framework`	string	Optional	Framework name (next, django, etc.)
`ecosystem`	string	Optional	Filter by ecosystem
`strict_mode`	boolean	Optional	Only return required packages

POST
`/v1/stack/align`

Compute how well a project aligns with canonical stack

workspace+

Name	Type	Required	Description
`framework`	string	Required	Target framework
`packages`	string[]	Required	Project packages to analyze
`strictMode`	boolean	Optional	Enforce required packages

POST
`/v1/stack/generate`

Generate recommended stacks based on use-case requirements (agent-optimized)

workspace+

Name	Type	Required	Description
`useCases`	string[]	Required	Use cases: realtime, ai, ecommerce, cms, saas, api, mobile, desktop, cli, data, devtools
`framework`	string	Optional	Target framework (next, django, etc.)
`ecosystem`	string	Optional	Target ecosystem (npm, pypi, etc.)
`scale`	string	Optional	Scale: startup, growth, enterprise
`priorities`	string[]	Optional	Priorities: speed, stability, performance, cost

Error Codes

Code	HTTP Status	Description
`INVALID_API_KEY`	401	Missing or invalid API key
`INSUFFICIENT_TIER`	403	Your plan doesn't include this endpoint
`RATE_LIMIT_EXCEEDED`	429	Too many requests, check Retry-After header
`QUOTA_EXCEEDED`	429	Daily quota exhausted, resets at midnight UTC
`INVALID_REQUEST`	400	Invalid parameters or request body
`INTERNAL_ERROR`	500	Server error, please try again

Response Headers

Header	Description
`X-RateLimit-Limit`	Your daily quota for this endpoint
`X-RateLimit-Remaining`	Remaining requests in current period
`X-RateLimit-Reset`	ISO 8601 timestamp when quota resets
`X-API-Version`	API version (currently 1.0.0)
`Retry-After`	Seconds to wait before retrying (on 429)

Need help? Contact API support

Back to Documentation

Public API Reference

REST API for programmatic access to PatternStack package intelligence. Requires a Workspace subscription or higher.

Quick Start

Get started with the PatternStack API in minutes

Base URL

https://api.patternstack.ai/v1

Authentication

Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Get your API key from Dashboard → API Keys

Example Request

curl -X GET "https://api.patternstack.ai/v1/packages/search?q=date&ecosystem=npm" \
  -H "Authorization: Bearer ts_live_xxxx"

Rate Limits & Quotas

Daily quotas reset at midnight UTC

Tier	Search	Compare	AI Insights	Security
Free	-	-	-	-
Premium	500/day	200/day	100/day	50/day
Workspace	100/day	50/day	10/day*	10/day

* Free tier AI Insights returns truncated previews (150 chars). Upgrade to Workspace for full responses.

Endpoints

GET
`/v1/packages/search`

Search packages with trend and health signals

workspace+

Name	Type	Required	Description
`q`	string	Required	Search query
`ecosystem`	string	Optional	Filter by ecosystem (npm, pypi, etc.)
`framework`	string	Optional	Filter by framework context
`limit`	number	Optional	Max results (default: 20, max: 50)

POST
`/v1/packages/compare`

Compare 2-10 packages with relative rankings

workspace+

Name	Type	Required	Description
`packages`	string[]	Required	Array of package names (2-10)
`ecosystem`	string	Optional	Ecosystem context

POST
`/v1/insights/explain`

AI-powered package explanations and recommendations

workspace+

Name	Type	Required	Description
`packages`	string[]	Required	Packages to analyze
`question`	string	Optional	Specific question to answer
`context`	object	Optional	Framework/project context

GET
`/v1/migrations/{package}`

Get migration paths for declining packages

workspace+

Name	Type	Required	Description
`package`	string	Required	Package name (path parameter)
`ecosystem`	string	Optional	Package ecosystem

GET
`/v1/trends`

Trending packages by ecosystem and framework

workspace+

Name	Type	Required	Description
`ecosystem`	string	Required	Ecosystem (npm, pypi, etc.)
`framework`	string	Optional	Filter by framework
`direction`	string	Optional	rising, declining, or all
`limit`	number	Optional	Max results (default: 20)

GET
`/v1/packages/{name}/alternatives`

Find alternatives to a specific package

workspace+

Name	Type	Required	Description
`name`	string	Required	Package name (path parameter)
`ecosystem`	string	Optional	Package ecosystem

POST
`/v1/analyze`

Stateless analysis for CI/CD pipelines

workspace+

Name	Type	Required	Description
`packageJson`	object	Optional	package.json contents
`requirementsTxt`	string	Optional	requirements.txt contents
`goMod`	string	Optional	go.mod contents

POST
`/v1/security/scan`

Vulnerability scanning for dependencies

workspace+

Name	Type	Required	Description
`packageJson`	object	Optional	package.json with dependencies
`requirementsTxt`	string	Optional	Python requirements
`severityFilter`	string	Optional	critical, high, medium, or low

GET
`/v1/stack/defaults`

Get canonical industry-standard stack for a framework (agent-optimized)

free+

Name	Type	Required	Description
`framework`	string	Optional	Framework name (next, django, etc.)
`ecosystem`	string	Optional	Filter by ecosystem
`strict_mode`	boolean	Optional	Only return required packages

POST
`/v1/stack/align`

Compute how well a project aligns with canonical stack

workspace+

Name	Type	Required	Description
`framework`	string	Required	Target framework
`packages`	string[]	Required	Project packages to analyze
`strictMode`	boolean	Optional	Enforce required packages

POST
`/v1/stack/generate`

Generate recommended stacks based on use-case requirements (agent-optimized)

workspace+

Name	Type	Required	Description
`useCases`	string[]	Required	Use cases: realtime, ai, ecommerce, cms, saas, api, mobile, desktop, cli, data, devtools
`framework`	string	Optional	Target framework (next, django, etc.)
`ecosystem`	string	Optional	Target ecosystem (npm, pypi, etc.)
`scale`	string	Optional	Scale: startup, growth, enterprise
`priorities`	string[]	Optional	Priorities: speed, stability, performance, cost

Error Codes

Code	HTTP Status	Description
`INVALID_API_KEY`	401	Missing or invalid API key
`INSUFFICIENT_TIER`	403	Your plan doesn't include this endpoint
`RATE_LIMIT_EXCEEDED`	429	Too many requests, check Retry-After header
`QUOTA_EXCEEDED`	429	Daily quota exhausted, resets at midnight UTC
`INVALID_REQUEST`	400	Invalid parameters or request body
`INTERNAL_ERROR`	500	Server error, please try again

Response Headers

Header	Description
`X-RateLimit-Limit`	Your daily quota for this endpoint
`X-RateLimit-Remaining`	Remaining requests in current period
`X-RateLimit-Reset`	ISO 8601 timestamp when quota resets
`X-API-Version`	API version (currently 1.0.0)
`Retry-After`	Seconds to wait before retrying (on 429)

Need help? Contact API support

Public API Reference

Quick Start

Base URL

Authentication

Example Request

Rate Limits & Quotas

Endpoints

GET/v1/packages/search

POST/v1/packages/compare

POST/v1/insights/explain

GET/v1/migrations/{package}

GET/v1/trends

GET/v1/packages/{name}/alternatives

POST/v1/analyze

POST/v1/security/scan

GET/v1/stack/defaults

POST/v1/stack/align

POST/v1/stack/generate

Error Codes

Response Headers

Public API Reference

Quick Start

Base URL

Authentication

Example Request

Rate Limits & Quotas

Endpoints

GET/v1/packages/search

POST/v1/packages/compare

POST/v1/insights/explain

GET/v1/migrations/{package}

GET/v1/trends

GET/v1/packages/{name}/alternatives

POST/v1/analyze

POST/v1/security/scan

GET/v1/stack/defaults

POST/v1/stack/align

POST/v1/stack/generate

Error Codes

Response Headers

GET
`/v1/packages/search`

POST
`/v1/packages/compare`

POST
`/v1/insights/explain`

GET
`/v1/migrations/{package}`

GET
`/v1/trends`

GET
`/v1/packages/{name}/alternatives`

POST
`/v1/analyze`

POST
`/v1/security/scan`

GET
`/v1/stack/defaults`

POST
`/v1/stack/align`

POST
`/v1/stack/generate`

GET
`/v1/packages/search`

POST
`/v1/packages/compare`

POST
`/v1/insights/explain`

GET
`/v1/migrations/{package}`

GET
`/v1/trends`

GET
`/v1/packages/{name}/alternatives`

POST
`/v1/analyze`

POST
`/v1/security/scan`

GET
`/v1/stack/defaults`

POST
`/v1/stack/align`

POST
`/v1/stack/generate`