API reference / Public

Public catalog

The public catalog pages’ data: publishers, series, issues and new releases. CDN-cacheable.

GET/api/v1/public/catalog

The catalog home

Public

Counts, the biggest publishers, key issues and first issues.

SDK: collector.getPublicCatalogHome()
Headers: If-None-MatchX-Request-Id

Responses

200The catalog home page’s data.
PublicCatalogHome
- countsobjectrequired
  Fields of counts
  issuesintegerrequired
  seriesintegerrequired
  publishersintegerrequired
- publishersarray of objectrequired
  Fields of publishers
  idstring (uuid)required
  namestringrequired
  slugstringrequired
  logoUrlstring (uri) or nullrequired
  seriesCountintegerrequired
- keyIssuesarray of PublicIssueCardrequired
- firstIssuesarray of PublicIssueCardrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (429, 500)

429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/catalog'

TypeScript SDK

await collector.getPublicCatalogHome();

Try it· sends a real request to collection.id from this page

GET/api/v1/public/catalog/issues/{id}/listings

Shops’ copies of an issue

Public

"Buy a copy": our shops’ copies of an issue, best grade first. An unknown issue has none.

SDK: collector.getPublicIssueListings()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`id`required	path	string (uuid)

Responses

200Listings.
object
- listingsarray of BuyListingrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (404, 429, 500)

404not_found
not_found: Nothing at that address.
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/catalog/issues/<id>/listings'

TypeScript SDK

await collector.getPublicIssueListings({ path: { id } });

Try it· sends a real request to collection.id from this page

GET/api/v1/public/catalog/new-releases

New releases

Public

This week’s comics and the next two weeks’, by store date.

SDK: collector.getPublicNewReleases()
Headers: If-None-MatchX-Request-Id

Responses

200Weeks of releases.
PublicNewReleases
- todaystring (date)required
- weeksarray of objectrequired
  Fields of weeks
  startstring (date)required
  Monday.
  endstring (date)required
  Sunday.
  offsetintegerrequired
  Weeks from this week: 0 this week, 1 next week.
  labelstringrequired
  rangestringrequired
  rowsarray of PublicReleaseCardrequired
- truncatedbooleanrequired
- totalintegerrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (429, 500)

429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/catalog/new-releases'

TypeScript SDK

await collector.getPublicNewReleases();

Try it· sends a real request to collection.id from this page

GET/api/v1/public/catalog/publishers/{slug}

A publisher or imprint

PublicPaginated (page)

The publisher page: its overview, key issues, recent releases and one page of its series browser (filters as on the page). A merged publisher answers { redirect }.

SDK: collector.getPublicPublisher()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`slug`required	path	string	1–200 characters
`era`optional	query	string	A decade, e.g. 1990.
`format`optional	query	string
`status`optional	query	string
`q`optional	query	string
`sort`optional	query	string
`page`optional	query	string	Page of the series browser, from 1.

Responses

200The publisher, or where it lives now.
PublicPublisherView or Redirect
1. Option 1: PublicPublisherView
2. Option 2: Redirect
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 429, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Nothing at that address.
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/catalog/publishers/<slug>'

TypeScript SDK

await collector.getPublicPublisher({ path: { slug }, query: { … } });

Try it· sends a real request to collection.id from this page

GET/api/v1/public/catalog/search

Search the public catalog

Public

The catalog page’s search: issues and series in the local catalog (no provider lookups), and the publishers and imprints a bare name matches.

SDK: collector.searchPublicCatalog()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`q`optional	query	string	What to look for.

Responses

200Matches.
PublicCatalogSearch
- qstringrequired
- issuesarray of PublicIssueCardrequired
- seriesarray of PublicSeriesCardrequired
- publishersarray of objectoptional
  Publishers and imprints named like the query.
  Fields of publishers
  namestringrequired
  slugstringrequired
  parentobject or nullrequired
  The publisher an imprint belongs to.
  Fields of parent
  namestringrequired
  slugstringrequired
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 429, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/catalog/search'

TypeScript SDK

await collector.searchPublicCatalog({ query: { … } });

Try it· sends a real request to collection.id from this page

GET/api/v1/public/catalog/series/{slug}

A series

Public

The series page with one block of its run (?block=, the first without one). A merged or renamed series answers { redirect }.

SDK: collector.getPublicSeries()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`slug`required	path	string	1–200 characters
`block`optional	query	string	A block key: 'all', '1-100', 'v3'…

Responses

200The series, or where it lives now.
PublicSeriesView or Redirect
1. Option 1: PublicSeriesView
2. Option 2: Redirect
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (400, 404, 429, 500)

400invalid_request
invalid_request: The query or body doesn’t match the schema (see errors[]).
404not_found
not_found: Nothing at that address.
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/catalog/series/<slug>'

TypeScript SDK

await collector.getPublicSeries({ path: { slug }, query: { … } });

Try it· sends a real request to collection.id from this page

GET/api/v1/public/catalog/series/{slug}/{issue}

An issue

Public

The issue page: editions, credits, first appearances, owners, market prices and our shops’ copies. A merged or renamed issue answers { redirect }.

SDK: collector.getPublicIssue()
Headers: If-None-MatchX-Request-Id

Parameters

Name	In	Type	About
`slug`required	path	string	1–200 characters
`issue`required	path	string	1–200 characters

Responses

200The issue, or where it lives now.
PublicIssueView or Redirect
1. Option 1: PublicIssueView
2. Option 2: Redirect
304Not modified: your copy (the ETag in If-None-Match) is current.

Errors (404, 429, 500)

404not_found
not_found: Nothing at that address.
429rate_limited
rate_limited: Signed out: too many requests from your network.
500internal
internal: Something went wrong on our side (quote the requestId).

curl

curl 'https://collection.id/api/v1/public/catalog/series/<slug>/<issue>'

TypeScript SDK

await collector.getPublicIssue({ path: { slug, issue } });

Try it· sends a real request to collection.id from this page