Skip to main content
GET
/
v2
/
components
/
search
Search for components
curl --request GET \
  --url https://api.scanoss.com/v2/components/search
{
  "components": [
    {
      "name": "scanoss-py",
      "purl": "pkg:github/scanoss/scanoss.py",
      "url": "https://github.com/scanoss/scanoss.py",
      "component": "scanoss-py"
    },
    {
      "name": "engine",
      "purl": "pkg:github/scanoss/engine",
      "url": "https://github.com/scanoss/engine",
      "component": "engine"
    }
  ],
  "status": {
    "status": "SUCCESS",
    "message": "Components successfully retrieved"
  }
}

Query Parameters

​
search
string

Component to search for (vendor/component/purl). Search is exclusive (will override vendor/component)

​
vendor
string

Vendor to search for. Vendor can be combined with Component

​
component
string

Component to search for. Component can be combined with Vendor

​
package
string

Type of package (purl type) to search for. i.e. github, maven, golang, npm, all - default github

​
limit
integer<int32>

Number of matches to return - default 50

​
offset
integer<int32>

Offset to submit to return the next (limit) of component matches

Response

A successful response.

​
components
Component details · object[]
​
status
object

Detailed response details.