Get Base Material Library List
curl --request POST \
--url https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-developer-request-token: <api-key>' \
--data '
{
"filter": {
"logic": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {}
}
]
},
"skip": 123,
"take": 123,
"sort": [
{
"field": "<string>",
"dir": "<string>",
"isNotNested": true
}
],
"searchStr": "<string>"
}
'import requests
url = "https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list"
payload = {
"filter": {
"logic": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {}
}
]
},
"skip": 123,
"take": 123,
"sort": [
{
"field": "<string>",
"dir": "<string>",
"isNotNested": True
}
],
"searchStr": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-developer-request-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-developer-request-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {
logic: '<string>',
filters: [{field: '<string>', operator: '<string>', value: {}}]
},
skip: 123,
take: 123,
sort: [{field: '<string>', dir: '<string>', isNotNested: true}],
searchStr: '<string>'
})
};
fetch('https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list', 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-v2.production.higg.org/pic-api/v1/material-library/base-material-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'logic' => '<string>',
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => [
]
]
]
],
'skip' => 123,
'take' => 123,
'sort' => [
[
'field' => '<string>',
'dir' => '<string>',
'isNotNested' => true
]
],
'searchStr' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-developer-request-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list"
payload := strings.NewReader("{\n \"filter\": {\n \"logic\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {}\n }\n ]\n },\n \"skip\": 123,\n \"take\": 123,\n \"sort\": [\n {\n \"field\": \"<string>\",\n \"dir\": \"<string>\",\n \"isNotNested\": true\n }\n ],\n \"searchStr\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-developer-request-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list")
.header("x-api-key", "<api-key>")
.header("x-developer-request-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"logic\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {}\n }\n ]\n },\n \"skip\": 123,\n \"take\": 123,\n \"sort\": [\n {\n \"field\": \"<string>\",\n \"dir\": \"<string>\",\n \"isNotNested\": true\n }\n ],\n \"searchStr\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"logic\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {}\n }\n ]\n },\n \"skip\": 123,\n \"take\": 123,\n \"sort\": [\n {\n \"field\": \"<string>\",\n \"dir\": \"<string>\",\n \"isNotNested\": true\n }\n ],\n \"searchStr\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"total": 123,
"hits": [
{
"_id": "<string>",
"type": "<string>",
"name": "<string>",
"code": "<string>",
"category": "<string>",
"cycles": {},
"scores": {
"globalWarming": 123,
"eutrophication": 123,
"waterScarcity": 123,
"abioticDepletion": 123,
"chemistry": 123,
"globalWarmingPts": 123,
"eutrophicationPts": 123,
"waterScarcityPts": 123,
"abioticDepletionPts": 123,
"impact": 123,
"chemistryPts": 123,
"waterConsumption": 123,
"biogenicCarbon": 123
},
"_rev": "<string>",
"hidden": true,
"blendPercentage": 123,
"categoryRanking": 123,
"totalScoresTier2": 123,
"totalScoresTier3": 123,
"totalScoresTier4": 123,
"finishedMaterialChemCertsAvailable": [],
"finishedMaterialChemCertsSelected": []
}
],
"aggregations": {}
}Material Library
Get Base Material Library List
POST
/
material-library
/
base-material-list
Get Base Material Library List
curl --request POST \
--url https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-developer-request-token: <api-key>' \
--data '
{
"filter": {
"logic": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {}
}
]
},
"skip": 123,
"take": 123,
"sort": [
{
"field": "<string>",
"dir": "<string>",
"isNotNested": true
}
],
"searchStr": "<string>"
}
'import requests
url = "https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list"
payload = {
"filter": {
"logic": "<string>",
"filters": [
{
"field": "<string>",
"operator": "<string>",
"value": {}
}
]
},
"skip": 123,
"take": 123,
"sort": [
{
"field": "<string>",
"dir": "<string>",
"isNotNested": True
}
],
"searchStr": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"x-developer-request-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
'x-developer-request-token': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
filter: {
logic: '<string>',
filters: [{field: '<string>', operator: '<string>', value: {}}]
},
skip: 123,
take: 123,
sort: [{field: '<string>', dir: '<string>', isNotNested: true}],
searchStr: '<string>'
})
};
fetch('https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list', 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-v2.production.higg.org/pic-api/v1/material-library/base-material-list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'filter' => [
'logic' => '<string>',
'filters' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => [
]
]
]
],
'skip' => 123,
'take' => 123,
'sort' => [
[
'field' => '<string>',
'dir' => '<string>',
'isNotNested' => true
]
],
'searchStr' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-developer-request-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list"
payload := strings.NewReader("{\n \"filter\": {\n \"logic\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {}\n }\n ]\n },\n \"skip\": 123,\n \"take\": 123,\n \"sort\": [\n {\n \"field\": \"<string>\",\n \"dir\": \"<string>\",\n \"isNotNested\": true\n }\n ],\n \"searchStr\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-developer-request-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list")
.header("x-api-key", "<api-key>")
.header("x-developer-request-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"filter\": {\n \"logic\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {}\n }\n ]\n },\n \"skip\": 123,\n \"take\": 123,\n \"sort\": [\n {\n \"field\": \"<string>\",\n \"dir\": \"<string>\",\n \"isNotNested\": true\n }\n ],\n \"searchStr\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-v2.production.higg.org/pic-api/v1/material-library/base-material-list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["x-developer-request-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"filter\": {\n \"logic\": \"<string>\",\n \"filters\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": {}\n }\n ]\n },\n \"skip\": 123,\n \"take\": 123,\n \"sort\": [\n {\n \"field\": \"<string>\",\n \"dir\": \"<string>\",\n \"isNotNested\": true\n }\n ],\n \"searchStr\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"total": 123,
"hits": [
{
"_id": "<string>",
"type": "<string>",
"name": "<string>",
"code": "<string>",
"category": "<string>",
"cycles": {},
"scores": {
"globalWarming": 123,
"eutrophication": 123,
"waterScarcity": 123,
"abioticDepletion": 123,
"chemistry": 123,
"globalWarmingPts": 123,
"eutrophicationPts": 123,
"waterScarcityPts": 123,
"abioticDepletionPts": 123,
"impact": 123,
"chemistryPts": 123,
"waterConsumption": 123,
"biogenicCarbon": 123
},
"_rev": "<string>",
"hidden": true,
"blendPercentage": 123,
"categoryRanking": 123,
"totalScoresTier2": 123,
"totalScoresTier3": 123,
"totalScoresTier4": 123,
"finishedMaterialChemCertsAvailable": [],
"finishedMaterialChemCertsSelected": []
}
],
"aggregations": {}
}Use this endpoint to browse the base material catalog. Base materials are the raw material building blocks (e.g., cotton, polyester, nylon) that you use when creating custom materials in the material library.
Implementation Details
- Textile category: Results are filtered to the textile (
TX) category by default. - Searchable: Supports text search and standard filtering parameters (skip, take, sort, filter) for advanced queries.
- Usage: Use the returned base material IDs in the
baseMaterialsarray when creating a custom material.
Body
application/json
⌘I

