Search for components
curl --request GET \
--url https://api.scanoss.com/v2/components/searchimport requests
url = "https://api.scanoss.com/v2/components/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.scanoss.com/v2/components/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scanoss.com/v2/components/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scanoss.com/v2/components/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scanoss.com/v2/components/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scanoss.com/v2/components/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}
}"<string>"{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Components
Search for components
GET
/
v2
/
components
/
search
Search for components
curl --request GET \
--url https://api.scanoss.com/v2/components/searchimport requests
url = "https://api.scanoss.com/v2/components/search"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.scanoss.com/v2/components/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.scanoss.com/v2/components/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.scanoss.com/v2/components/search"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.scanoss.com/v2/components/search")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.scanoss.com/v2/components/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"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"
}
}"<string>"{
"code": 123,
"message": "<string>",
"details": [
{
"@type": "<string>"
}
]
}Query Parameters
Component to search for (vendor/component/purl). Search is exclusive (will override vendor/component)
Vendor to search for. Vendor can be combined with Component
Component to search for. Component can be combined with Vendor
Type of package (purl type) to search for. i.e. github, maven, golang, npm, all - default github
Number of matches to return - default 50
Offset to submit to return the next (limit) of component matches