API reference / Collectors
6 operations.
/api/v1/insights/gradingRaw copies with their raw and likely-slabbed estimates, against the graders’ fees.
collector.getGradingCandidates()insights:read(API keys are coming soon)If-None-MatchX-Request-IdRaw copies with their raw and likely-slabbed estimates, and the graders’ fees.
currencystringrequiredISO 4217 code, e.g. USD.
feesobjectrequiredcheckedOnstring (date) or nullrequiredcurrencystringrequiredISO 4217 code, e.g. USD.
companiesarray of objectrequiredcompanyenumrequiredOne ofcgccbcspsapgxegshgaother
sourceUrlstring (uri) or nullrequirednotestring or nullrequiredhandlingCentsPerInvoiceinteger or nullrequiredtiersarray of objectrequiredidstringrequirednamestringrequiredfeeCentsinteger or nullrequiredpercentOfValuenumber or nulloptionalminFeeCentsinteger or nulloptionalmaxValueCentsinteger or nullrequirederaenum or nulloptionalOne ofmodernvintage
minBooksinteger or nulloptionalturnaroundDaysinteger or nulloptionalfeesSourceenumrequiredOne ofsettingsdefault
candidatesarray of objectrequireditemIdstring (uuid)requiredissueIdstring (uuid)requirededitionIdstring (uuid) or nullrequiredseriesTitlestring or nullrequiredissueNumberstring or nullrequirededitionNamestring or nullrequiredcoverUrlstring (uri) or nullrequiredcoverYearinteger or nullrequiredisKeybooleanrequiredgradenumberrequiredpurchasePriceCentsinteger or nullrequiredpurchaseCurrencystring or nullrequireduserValueCentsinteger or nullrequiredrawobject or nullrequiredvalueCentsintegerrequiredlowCentsinteger or nullrequiredhighCentsinteger or nullrequiredcurrencystringrequiredISO 4217 code, e.g. USD.
methodstringrequiredsampleSizeintegerrequiredconfidenceLabelenum or nullrequiredOne oflowfairgoodstrong
outcomesarray of objectrequiredbandIdenumrequiredA grade band: 9.8+, 9.0-9.6, 7.0-8.5, 4.0-6.5, under-4.
One of9.8+9.0-9.67.0-8.54.0-6.5under-4
positionenumrequiredOne oflowersamehigher
estimateobject or nullrequiredvalueCentsintegerrequiredlowCentsinteger or nullrequiredhighCentsinteger or nullrequiredcurrencystringrequiredISO 4217 code, e.g. USD.
methodstringrequiredsampleSizeintegerrequiredconfidenceLabelenum or nullrequiredOne oflowfairgoodstrong
skippedobjectrequirednoGradeintegerrequirednotComparableintegerrequiredunauthorized: Not signed in (no session or token, or an expired one).
feature_required: The plan doesn’t include this (details.feature names it).
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/insights/grading' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getGradingCandidates();/api/v1/insights/historyDaily snapshots of value, cost and copies, plus today.
collector.getPortfolioHistory()insights:read(API keys are coming soon)If-None-MatchX-Request-Id| Name | In | Type | About |
|---|---|---|---|
daysoptional | query | integer | Days back (7 to 3650, default 365). |
Daily portfolio snapshots, plus today.
currencystringrequiredISO 4217 code, e.g. USD.
daysintegerrequiredpointsarray of objectrequireddaystring (date)requiredvalueCentsintegerrequiredcostCentsintegerrequiredownedCountintegerrequiredsnapshotCountintegerrequiredDaily snapshots recorded (today’s live point excluded).
invalid_request: The query or body doesn’t match the schema (see errors[]).
unauthorized: Not signed in (no session or token, or an expired one).
feature_required: The plan doesn’t include this (details.feature names it).
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/insights/history' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getPortfolioHistory({ query: { … } });/api/v1/insights/items/{id}The copy’s value with its evidence: the estimate, every band in its pool, its history and shops’ asking prices.
collector.getItemValue()insights:read(API keys are coming soon)If-None-MatchX-Request-Id| Name | In | Type | About |
|---|---|---|---|
idrequired | path | string (uuid) |
One copy’s value with the evidence behind it.
itemobjectrequiredidstring (uuid)requiredstatusenumrequiredOne ofownedwishlistsold
issueIdstring (uuid)requirededitionIdstring (uuid) or nullrequiredseriesIdstring (uuid) or nullrequiredseriesTitlestring or nullrequiredseriesSlugstring or nullrequiredseriesStartYearinteger or nullrequiredissueNumberstring or nullrequiredissueSlugstring or nullrequiredpublisherNamestring or nullrequirededitionNamestring or nullrequiredcoverUrlstring (uri) or nullrequiredcoverYearinteger or nullrequiredisKeybooleanrequiredgradenumber or nullrequiredgradingCompanystring or nullrequiredlabelTypestring or nullrequiredcertNumberstring or nullrequiredisSignedbooleanrequiredisRestoredbooleanrequiredpurchasePriceCentsinteger or nullrequiredpurchaseCurrencystring or nullrequiredacquiredOnstring (date) or nullrequiredvalueCentsinteger or nullrequiredvalueLowCentsinteger or nullrequiredvalueHighCentsinteger or nullrequiredvalueCurrencystring or nullrequiredvalueConfidencenumber or nullrequiredvalueMethodstring or nullrequiredvalueUpdatedAtstring (date-time) or nullrequireduserValueCentsinteger or nullrequireduserValueNotestring or nullrequireduserValueSetAtstring (date-time) or nullrequiredkeyobject or nullrequiredThe pool and band the copy is valued in; null when it can’t be valued.
issueIdstring (uuid)requirededitionIdstring (uuid) or nullrequiredgradedbooleanrequiredbandIdenumrequiredA grade band: 9.8+, 9.0-9.6, 7.0-8.5, 4.0-6.5, under-4.
One of9.8+9.0-9.67.0-8.54.0-6.5under-4
bandFloornumberrequirednotValuedobject or nullrequiredreasonenumrequiredWhy a copy has no system value.
One ofno_gradesignedrestoredspecial_labelno_estimateplanpendingedition_unknown
Today’s estimate for the copy’s band, from the same pool the nightly job uses.
stalebooleanrequiredThe value on the copy differs from today’s estimate.
poolobjectrequirededitionIdstring (uuid) or nullrequiredconsideredintegerrequiredcurrencystring or nullrequiredEvery band with an estimate in the pool.
historyarray of objectrequiredatstring (date-time)requiredvalueCentsintegerrequiredlowCentsinteger or nullrequiredhighCentsinteger or nullrequiredmethodstring or nullrequiredshopsobject or nullrequiredAsking prices at shops: a separate signal, never part of an estimate.
countintegerrequiredminCentsintegerrequiredmaxCentsintegerrequiredcurrencystringrequiredISO 4217 code, e.g. USD.
listingsarray of objectrequiredlistingIdstring (uuid)requiredstoreNamestringrequiredstoreSlugstringrequiredcitystring or nullrequiredregionstring or nullrequiredpriceCentsintegerrequiredcurrencystringrequiredISO 4217 code, e.g. USD.
gradenumber or nullrequiredgradingCompanystring or nullrequiredebayUrlstring (uri)requiredsharesMarketDatabooleanrequiredunauthorized: Not signed in (no session or token, or an expired one).
feature_required: The plan doesn’t include this (details.feature names it).
not_found: Nothing at that address.
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/insights/items/<id>' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getItemValue({ path: { id } });/api/v1/insights/moversCopies whose estimate moved most over the period.
collector.getPortfolioMovers()insights:read(API keys are coming soon)If-None-MatchX-Request-Id| Name | In | Type | About |
|---|---|---|---|
daysoptional | query | integer | Days back (1 to 3650, default 30). |
Copies whose estimate moved most over the period.
currencystringrequiredISO 4217 code, e.g. USD.
daysintegerrequiredmoversarray of objectrequireditemIdstring (uuid)requiredseriesTitlestring or nullrequiredissueNumberstring or nullrequiredcoverUrlstring (uri) or nullrequiredgradenumber or nullrequiredgradingCompanystring or nullrequiredvalueThenCentsintegerrequiredvalueNowCentsintegerrequiredchangeCentsintegerrequiredinvalid_request: The query or body doesn’t match the schema (see errors[]).
unauthorized: Not signed in (no session or token, or an expired one).
feature_required: The plan doesn’t include this (details.feature names it).
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/insights/movers' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getPortfolioMovers({ query: { … } });/api/v1/insights/portfolioCounts and cost basis for every plan; market value, gains, breakdowns, copies not yet valued and the sales log with the insights feature.
collector.getPortfolio()insights:read(API keys are coming soon)If-None-MatchX-Request-IdCounts and cost basis for every plan; values, gains, breakdowns and the sales log with insights.
currencystringrequiredISO 4217 code, e.g. USD.
sharesMarketDatabooleanrequiredbasicsobjectrequiredcurrencystringrequiredISO 4217 code, e.g. USD.
ownedCountintegerrequiredwishlistCountintegerrequiredsoldCountintegerrequiredslabCountintegerrequiredrawCountintegerrequiredsignedCountintegerrequiredkeyCountintegerrequiredcostBasisCentsintegerrequiredcostKnownCountintegerrequiredkpisobject or nullrequiredNull without the insights feature.
currencystringrequiredISO 4217 code, e.g. USD.
ownedCountintegerrequiredwishlistCountintegerrequiredsoldCountintegerrequiredslabCountintegerrequiredrawCountintegerrequiredsignedCountintegerrequiredkeyCountintegerrequiredvaluedCountintegerrequiredyourValueCountintegerrequiredunvaluedCountintegerrequiredmarketValueCentsintegerrequiredmarketValueLowCentsintegerrequiredmarketValueHighCentsintegerrequiredcostBasisCentsintegerrequiredcostKnownCountintegerrequiredunrealizedobject or nullrequiredgainCentsintegerrequiredcostCentsintegerrequiredproceedsCentsintegerrequiredValue (unrealized) or sale proceeds (realized).
countintegerrequiredroinumber or nullrequiredgain / cost; null when the cost is zero.
realizedobject or nullrequiredgainCentsintegerrequiredcostCentsintegerrequiredproceedsCentsintegerrequiredValue (unrealized) or sale proceeds (realized).
countintegerrequiredroinumber or nullrequiredgain / cost; null when the cost is zero.
totalobject or nullrequiredgainCentsintegerrequiredcostCentsintegerrequiredproceedsCentsintegerrequiredValue (unrealized) or sale proceeds (realized).
countintegerrequiredroinumber or nullrequiredgain / cost; null when the cost is zero.
otherCurrencyCountintegerrequiredbreakdownsobject or nullrequiredpublisherarray of objectrequiredkeystringrequiredlabelstringrequiredcountintegerrequiredvaluedCountintegerrequiredvalueCentsintegerrequiredcostCentsintegerrequiredformatarray of objectrequiredkeystringrequiredlabelstringrequiredcountintegerrequiredvaluedCountintegerrequiredvalueCentsintegerrequiredcostCentsintegerrequiredgradingCompanyarray of objectrequiredkeystringrequiredlabelstringrequiredcountintegerrequiredvaluedCountintegerrequiredvalueCentsintegerrequiredcostCentsintegerrequiredgradeBandarray of objectrequiredkeystringrequiredlabelstringrequiredcountintegerrequiredvaluedCountintegerrequiredvalueCentsintegerrequiredcostCentsintegerrequiredkeysarray of objectrequiredkeystringrequiredlabelstringrequiredcountintegerrequiredvaluedCountintegerrequiredvalueCentsintegerrequiredcostCentsintegerrequiredsignedarray of objectrequiredkeystringrequiredlabelstringrequiredcountintegerrequiredvaluedCountintegerrequiredvalueCentsintegerrequiredcostCentsintegerrequiredunvaluedarray of object or nullrequiredidstring (uuid)requiredseriesTitlestring or nullrequiredissueNumberstring or nullrequirededitionNamestring or nullrequiredcoverUrlstring (uri) or nullrequiredgradenumber or nullrequiredgradingCompanystring or nullrequiredlabelTypestring or nullrequiredisSignedbooleanrequiredreasonenumrequiredWhy a copy has no system value.
One ofno_gradesignedrestoredspecial_labelno_estimateplanpendingedition_unknown
hasPurchasePricebooleanrequiredunvaluedTotalintegerrequiredsalesarray of object or nullrequiredidstring (uuid)requiredseriesTitlestring or nullrequiredissueNumberstring or nullrequirededitionNamestring or nullrequiredcoverUrlstring (uri) or nullrequiredgradenumber or nullrequiredgradingCompanystring or nullrequiredlabelTypestring or nullrequiredacquiredOnstring (date) or nullrequiredsoldOnstring (date) or nullrequiredcostCentsinteger or nullrequiredsaleCentsinteger or nullrequiredcurrencystringrequiredISO 4217 code, e.g. USD.
gainCentsinteger or nullrequiredroinumber or nullrequiredholdingDaysinteger or nullrequiredlastValuedAtstring (date-time) or nullrequiredunauthorized: Not signed in (no session or token, or an expired one).
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/insights/portfolio' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getPortfolio();/api/v1/insights/reportEvery owned copy with what identifies it, what was paid and its value (Pro). JSON by default; ?format=csv answers a CSV download (text/csv) instead.
collector.getInsuranceReport()insights:read(API keys are coming soon)X-Request-Id| Name | In | Type | About |
|---|---|---|---|
formatoptional | query | enum | csv for a spreadsheet download.One of json, csv |
object
invalid_request: The query or body doesn’t match the schema (see errors[]).
unauthorized: Not signed in (no session or token, or an expired one).
feature_required: The plan doesn’t include this (details.feature names it).
internal: Something went wrong on our side (quote the requestId).
curl 'https://collection.id/api/v1/insights/report' \
-H "Authorization: Bearer $COLLECTOR_TOKEN"await collector.getInsuranceReport({ query: { … } });