I/O Docs: API Documentation

OAuth 2.0 Flow: Select OAuth 2.0 Flow

Existing Client Credentials: Manual Input

API Key:

App/Key: Select Application Key Manually provide key information

Shared Secret:

Client ID:

Client Secret: Authorize

Client ID: Get Access Token

Client ID:

Client Secret:

---

Username:

Password: Get Access Token

Client ID:

Client Secret: Get Access Token

Authorization Code: Get Access Token

Access Token:

Username:

Password:

Username:

Binary Security Token:

Username:

Password:

• author

  • List Methods
  • Expand Methods

  • GET listAuthors domains/{domain}/authors

    return a list of authors

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    category		string	restrict results by one or more category facets (a concatenation of the CAT_SET_ID dash the CAT_URI e.g. 'CN-/fiction')
    onTour	true false	string	only return authors that have a confirmed event in the next 180 days
    eventDateFrom		date	only return authors that have a confirmed event on or after this date (MM/dd/yyyy)
    eventDateTo		date	only return authors that have a confirmed event on or before this date (MM/dd/yyyy)
    eventMinPrintScore		int	only return authors that have a confirmed event with a title that has a print score greater than this number; print score is a weighted total in print for all ISBNs in a work
    hideAuthorsWithNoPhoto	true false	string	only return authors that have a photo on file according to the table AC_IMAGE_VW
    authorLastInitial		string	restrict results by one or more last initial facets
    showBio	true false	string	only return authors that have bio content
    sort		string	(default 'id') one of 'id', 'authorLast' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET getAuthor domains/{domain}/authors/{authorId}

    return details about an author

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {authorId}		int	restrict by author ID
    preferExport	true false	string	when set to true, will cause the items in the works element to prefer titles with the flag 'EXPORT' rather than just picking the frontlistiest
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

  • GET getAuthorContent domains/{domain}/authors/{authorId}/content

    return text about an author

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {authorId}		int	restrict by author ID
    preferExport	true false	string	when set to true, will cause the items in the works element to prefer titles with the flag 'EXPORT' rather than just picking the frontlistiest
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

  • GET listAuthorEvents domains/{domain}/authors/{authorId}/events

    return an author's events

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    state		string	restrict by state
    zip		string	restrict by zip code
    status		list	restrict by one or more event status
    eventDateFrom		date	return events on or after the supplied date
    eventDateTo		date	return events on or before the supplied date
    sort		string	(default 'id') one of 'id', 'eventdate', 'name', 'title', 'onsale'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {authorId}		int	restrict by author ID

  • GET listAuthorRoles domains/{domain}/authors/{authorId}/roles

    return an author's roles

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    {authorId}		int	restrict by author ID

  • GET listAuthorSeries domains/{domain}/authors/{authorId}/series

    return an author's series

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    series.countMin		int	restrict series to just those with a minimum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.countMax		int	restrict series to just those with a maximum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.numbered	true false	string	return numbered series (true) or unnumbered series (false)
    series.kids	true false	string	return series that have books with a Children or Young Adult consumer category (true) or don't (false)
    series.authorId		list	restrict series matching on the one or two primary authors that we've associated with the series; differs from 'authorId' which would test all the contributors attached to all the ISBN records that have the series code
    series.catUri		list	restrict series matching on the one or two primary categories that we've associated with the series; differs from 'catUri' which would test all the categories attached to all the ISBNS records that have the series code
    series.minPrintScore		int	restrict series to those where the most recent work's print score is at least a certain threshold
    series.ebookOriginal	true false	string	restrict series to those all the ISBN records with that series code have ORIGINAL_ISBN='ORIGINAL' and FORMAT_CODE='EL'
    sort		string	(default 'id') one of 'id', 'name', 'seriesDate', 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {authorId}		int	restrict by author ID

  • GET listAuthorTitles domains/{domain}/authors/{authorId}/titles

    return an author's titles

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	either 'USD' or 'CAD'; only needed if sort=price
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', 'price', 'frontlistiest', 'random'. Note that if 'price' is specified, then you must also specify 'sortPriceTypeCode' with either 'USD' or 'CAD'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {authorId}		int	restrict by author ID

  • GET listAuthorWebLinks domains/{domain}/authors/{authorId}/weblinks

    return an author's web links

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    linkAttr		int	restrict by one or more link attribute values
    {authorId}		int	restrict by author ID

  • GET listAuthorWorks domains/{domain}/authors/{authorId}/works

    return an author's works

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title_onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', random'; the 'title_onsale' is meant to sort on the on-sale date of the joined TITLE table rather than using the on-sale date of the work; for more information on 'printscore', see the Concepts page in the documentation of the same name.
    dir		string	(default 'asc') either 'asc' or 'desc'
    {authorId}		int	restrict by author ID

  • GET getViewAuthorListDisplay domains/{domain}/authors/views/list-display

    return extended information about a list of authors

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    category		string	restrict results by one or more category facets (a concatenation of the CAT_SET_ID dash the CAT_URI e.g. 'CN-/fiction')
    onTour	true false	string	only return authors that have a confirmed event in the next 180 days
    eventDateFrom		date	only return authors that have a confirmed event on or after this date (MM/dd/yyyy)
    eventDateTo		date	only return authors that have a confirmed event on or before this date (MM/dd/yyyy)
    eventMinPrintScore		int	only return authors that have a confirmed event with a title that has a print score greater than this number; print score is a weighted total in print for all ISBNs in a work
    hideAuthorsWithNoPhoto	true false	string	only return authors that have a photo on file according to the table AC_IMAGE_VW
    authorLastInitial		string	restrict results by one or more last initial facets
    showBio	true false	string	only return authors that have bio content
    sort		string	(default 'id') one of 'id', 'authorLast' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET getViewAuthorDisplay domains/{domain}/authors/{authorId}/views/author-display

    return extended information about an author

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {authorId}		int	restrict by author ID
    preferExport	true false	string	when set to true, will cause the items in the works element to prefer titles with the flag 'EXPORT' rather than just picking the frontlistiest
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'onsale') one of 'onsale',frontlistiest_onsale'

  • GET getAuthorViewAlsoPurchased domains/{domain}/authors/{authorId}/views/also-purchased

    return a list of works that were also purchased with the specified author's works

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    excludeSameAuthor	true false	string	(default=true) by default, all works from the same author are excluded but this parameter can be set to false to disable that behavior
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    {authorId}		int	restrict by author ID

• category

  • List Methods
  • Expand Methods

  • GET listCategories domains/{domain}/categories

    return a list of categories

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict by category set ID
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'name', 'seq', 'weight' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET getCategory domains/{domain}/categories/{catId}

    return details about a category

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {catId}		int	restrict by category ID

  • GET listCategoryChildren domains/{domain}/categories/{catId}/children

    return child categories of a category

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {catId}		int	restrict by category ID

  • GET listCategoryAuthors domains/{domain}/categories/{catId}/authors

    return authors in a category

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    {catId}		int	restrict by category ID

  • GET listCategorySeries domains/{domain}/categories/{catId}/series

    return series in a category

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    series.countMin		int	restrict series to just those with a minimum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.countMax		int	restrict series to just those with a maximum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.numbered	true false	string	return numbered series (true) or unnumbered series (false)
    series.kids	true false	string	return series that have books with a Children or Young Adult consumer category (true) or don't (false)
    series.authorId		list	restrict series matching on the one or two primary authors that we've associated with the series; differs from 'authorId' which would test all the contributors attached to all the ISBN records that have the series code
    series.catUri		list	restrict series matching on the one or two primary categories that we've associated with the series; differs from 'catUri' which would test all the categories attached to all the ISBNS records that have the series code
    series.minPrintScore		int	restrict series to those where the most recent work's print score is at least a certain threshold
    series.ebookOriginal	true false	string	restrict series to those all the ISBN records with that series code have ORIGINAL_ISBN='ORIGINAL' and FORMAT_CODE='EL'
    sort		string	(default 'id') one of 'id', 'name', 'seriesDate', 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {catId}		int	restrict by category ID

  • GET listCategoryTitles domains/{domain}/categories/{catId}/titles

    return titles in a category

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	either 'USD' or 'CAD'; only needed if sort=price
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', 'price', 'frontlistiest', 'random'. Note that if 'price' is specified, then you must also specify 'sortPriceTypeCode' with either 'USD' or 'CAD'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {catId}		int	restrict by category ID

  • GET listCategoryWorks domains/{domain}/categories/{catId}/works

    return works in a category

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title_onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', random'; the 'title_onsale' is meant to sort on the on-sale date of the joined TITLE table rather than using the on-sale date of the work; for more information on 'printscore', see the Concepts page in the documentation of the same name.
    dir		string	(default 'asc') either 'asc' or 'desc'
    {catId}		int	restrict by category ID

  • GET getCategoryHierarchy domains/{domain}/categories/views/hierarchy

    return the parent/child structure of a particular category set or from a particular category node up to a specified depth

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	set to true to suppress the work counts that are included with each category; recommended that you set this to true unless you need those counts
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    catId		int	restrict by category ID
    catSetId		string	restrict by category set ID
    catUri		string	restrict by the category URI, an alternative identifier to the category ID
    depth		int	limit the number of levels of children returned

  • GET getCatSet domains/{domain}/catsets/{catSetId}

    return details about a category set

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {catSetId}		string	restrict by category set ID

• catSet

  • List Methods
  • Expand Methods

  • GET listCatSets domains/{domain}/catsets

    return a list of category sets

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.

• consumerImprint

  • List Methods
  • Expand Methods

  • GET listConsumerImprints domains/{domain}/consumer-imprints

    return a list of consumer imprints

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

• division

  • List Methods
  • Expand Methods

  • GET listDivisions domains/{domain}/divisions

    return a list of divisions

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    isbn		long	restrict results based on one or more ISBNs (see /titles)

  • GET getDivision domains/{domain}/divisions/{divisionCode}

    return details about a division

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {divisionCode}		string	restrict by division code

  • GET listDivisionTitles domains/{domain}/divisions/{divisionCode}/titles

    return titles in a division

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	either 'USD' or 'CAD'; only needed if sort=price
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', 'price', 'frontlistiest', 'random'. Note that if 'price' is specified, then you must also specify 'sortPriceTypeCode' with either 'USD' or 'CAD'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {divisionCode}		string	restrict by division code

  • GET listDivisionWorks domains/{domain}/divisions/{divisionCode}/works

    return works in a division

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title_onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', random'; the 'title_onsale' is meant to sort on the on-sale date of the joined TITLE table rather than using the on-sale date of the work; for more information on 'printscore', see the Concepts page in the documentation of the same name.
    dir		string	(default 'asc') either 'asc' or 'desc'
    {divisionCode}		string	restrict by division code

• domain

  • List Methods
  • Expand Methods

  • GET listDomains domains

    return a list of domains

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

  • GET getDomain domains/{domain}

    return details about a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used

  • GET listAuthors domains/{domain}/authors

    return a list of authors in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    category		string	restrict results by one or more category facets (a concatenation of the CAT_SET_ID dash the CAT_URI e.g. 'CN-/fiction')
    onTour	true false	string	only return authors that have a confirmed event in the next 180 days
    eventDateFrom		date	only return authors that have a confirmed event on or after this date (MM/dd/yyyy)
    eventDateTo		date	only return authors that have a confirmed event on or before this date (MM/dd/yyyy)
    eventMinPrintScore		int	only return authors that have a confirmed event with a title that has a print score greater than this number; print score is a weighted total in print for all ISBNs in a work
    hideAuthorsWithNoPhoto	true false	string	only return authors that have a photo on file according to the table AC_IMAGE_VW
    authorLastInitial		string	restrict results by one or more last initial facets
    showBio	true false	string	only return authors that have bio content
    sort		string	(default 'id') one of 'id', 'authorLast' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET listCategories domains/{domain}/categories

    return a list of categories in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict by category set ID
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'name', 'seq', 'weight' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET listCatSets domains/{domain}/catsets

    return a list of category sets in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.

  • GET listConsumerImprints domains/{domain}/consumer-imprints

    return a list of consumer imprints in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

  • GET listDivisions domains/{domain}/divisions

    return a list of divisions in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    isbn		long	restrict results based on one or more ISBNs (see /titles)

  • GET listEvents domains/{domain}/events

    return a list of events in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    state		string	restrict by state
    zip		string	restrict by zip code
    status		list	restrict by one or more event status
    eventDateFrom		date	return events on or after the supplied date
    eventDateTo		date	return events on or before the supplied date
    sort		string	(default 'id') one of 'id', 'eventdate', 'name', 'title', 'onsale'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET listImprints domains/{domain}/imprints

    return a list of imprints in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs

  • GET doSearch domains/{domain}/search

    perform a search in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    q		string	query to search for
    docType		list	restrict by one or more document type facets
    docTypeExclude		list	exclude one or more document type facets from the result
    ageRange		list	restrict by one or more age range facets
    award		list	restrict by one or more award facets
    categoryId		list	restrict by one or more categoryId facets
    categoryLabel		list	restrict by one or more categoryLabel facets
    division		list	restrict by one or more division facets
    format		list	restrict by one or more format facets -- these are really format family values such as 'Paperback'
    subformat		list	restrict by one or more subformat facets
    formatCode		list	restrict by one or more formatCode facets
    imprint		list	restrict by one or more imprint facets
    series		list	restrict by one or more series facets
    bestseller	true false	string	restrict to records flagged as bestsellers
    awardWinner	true false	string	restrict to records flagged as award winners
    comingSoon	true false	string	restrict to records flagged as coming soon
    newRelease	true false	string	restrict to records flagged as new releases
    forthcomingRelease	true false	string	restrict to records flagged as forthcoming releases
    authorLastInitial		list	restrict authors by one or more author last initial facets
    contribRoleCode		list	restrict authors by one or more contrib role code facets
    companyCode		list	restrict authors by one or more company code facets
    author		list	restrict events by one or more author facets
    from		list	restrict events to those starting on or after the specified date
    to		list	restrict events to those starting on or before the specified date
    eventCityState		list	restrict events by one or more event city/state facets
    zip		string	restrict events based on proximitiy in miles to a zip code (must be specified with 'within')
    within		int	restrict events based on proximity in miles to a zip code (must be specified with 'zip')
    series.countMin		int	restrict series to only those that have at least this many works

  • GET listSeries domains/{domain}/series

    return a list of series in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    series.countMin		int	restrict series to just those with a minimum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.countMax		int	restrict series to just those with a maximum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.numbered	true false	string	return numbered series (true) or unnumbered series (false)
    series.kids	true false	string	return series that have books with a Children or Young Adult consumer category (true) or don't (false)
    series.authorId		list	restrict series matching on the one or two primary authors that we've associated with the series; differs from 'authorId' which would test all the contributors attached to all the ISBN records that have the series code
    series.catUri		list	restrict series matching on the one or two primary categories that we've associated with the series; differs from 'catUri' which would test all the categories attached to all the ISBNS records that have the series code
    series.minPrintScore		int	restrict series to those where the most recent work's print score is at least a certain threshold
    series.ebookOriginal	true false	string	restrict series to those all the ISBN records with that series code have ORIGINAL_ISBN='ORIGINAL' and FORMAT_CODE='EL'
    sort		string	(default 'id') one of 'id', 'name', 'seriesDate', 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET listTitles domains/{domain}/titles

    return a list of titles in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	either 'USD' or 'CAD'; only needed if sort=price
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', 'price', 'frontlistiest', 'random'. Note that if 'price' is specified, then you must also specify 'sortPriceTypeCode' with either 'USD' or 'CAD'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET listWorks domains/{domain}/works

    return a list of works in a domain

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title_onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', random'; the 'title_onsale' is meant to sort on the on-sale date of the joined TITLE table rather than using the on-sale date of the work; for more information on 'printscore', see the Concepts page in the documentation of the same name.
    dir		string	(default 'asc') either 'asc' or 'desc'

• event

  • List Methods
  • Expand Methods

  • GET listEvents domains/{domain}/events

    return a list of events

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    state		string	restrict by state
    zip		string	restrict by zip code
    status		list	restrict by one or more event status
    eventDateFrom		date	return events on or after the supplied date
    eventDateTo		date	return events on or before the supplied date
    sort		string	(default 'id') one of 'id', 'eventdate', 'name', 'title', 'onsale'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET getEvent domains/{domain}/events/{eventId}

    return details about an event

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {eventId}		int	restrict by event ID

  • GET getEventAuthors domains/{domain}/events/{eventId}/authors

    return an event's authors

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    category		string	restrict results by one or more category facets (a concatenation of the CAT_SET_ID dash the CAT_URI e.g. 'CN-/fiction')
    onTour	true false	string	only return authors that have a confirmed event in the next 180 days
    eventDateFrom		date	only return authors that have a confirmed event on or after this date (MM/dd/yyyy)
    eventDateTo		date	only return authors that have a confirmed event on or before this date (MM/dd/yyyy)
    eventMinPrintScore		int	only return authors that have a confirmed event with a title that has a print score greater than this number; print score is a weighted total in print for all ISBNs in a work
    hideAuthorsWithNoPhoto	true false	string	only return authors that have a photo on file according to the table AC_IMAGE_VW
    authorLastInitial		string	restrict results by one or more last initial facets
    showBio	true false	string	only return authors that have bio content
    sort		string	(default 'id') one of 'id', 'authorLast' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {eventId}		int	restrict by event ID

  • GET getEventWorks domains/{domain}/events/{eventId}/works

    return an event's works

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title_onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', random'; the 'title_onsale' is meant to sort on the on-sale date of the joined TITLE table rather than using the on-sale date of the work; for more information on 'printscore', see the Concepts page in the documentation of the same name.
    dir		string	(default 'asc') either 'asc' or 'desc'
    {eventId}		int	restrict by event ID

• format

  • List Methods
  • Expand Methods

  • GET listFormats domains/{domain}/formats

    return a list of formats

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    isbn		long	restrict results based on one or more ISBNs (see /titles)

  • GET getFormat domains/{domain}/formats/{format}

    return details about a format

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {format}		string	restrict by format code

• imprint

  • List Methods
  • Expand Methods

  • GET listImprints domains/{domain}/imprints

    return a list of imprints

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs

  • GET getImprint domains/{domain}/imprints/{imprintCode}

    return details about an imprint

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {imprintCode}		string	restrict by imprint code

• property

  • List Methods
  • Expand Methods

  • GET listProperties domains/{domain}/properties

    return a list of properties

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

  • GET getProperty domains/{domain}/properties/{propertyName}

    return details about a property

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {propertyName}		string	restrict by property name

• role

  • List Methods
  • Expand Methods

  • GET listRoles domains/{domain}/roles

    return a list of contributor roles

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

  • GET getRole domains/{domain}/roles/{role}

    return details about a contributor role

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {role}		string	restrict by role code

• search

  • List Methods
  • Expand Methods

  • GET listSearchResults domains/{domain}/search

    return a search result

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    q		string	query to search for
    docType		list	restrict by one or more document type facets
    docTypeExclude		list	exclude one or more document type facets from the result
    ageRange		list	restrict by one or more age range facets
    award		list	restrict by one or more award facets
    categoryId		list	restrict by one or more categoryId facets
    categoryLabel		list	restrict by one or more categoryLabel facets
    division		list	restrict by one or more division facets
    format		list	restrict by one or more format facets -- these are really format family values such as 'Paperback'
    subformat		list	restrict by one or more subformat facets
    formatCode		list	restrict by one or more formatCode facets
    imprint		list	restrict by one or more imprint facets
    series		list	restrict by one or more series facets
    bestseller	true false	string	restrict to records flagged as bestsellers
    awardWinner	true false	string	restrict to records flagged as award winners
    comingSoon	true false	string	restrict to records flagged as coming soon
    newRelease	true false	string	restrict to records flagged as new releases
    forthcomingRelease	true false	string	restrict to records flagged as forthcoming releases
    authorLastInitial		list	restrict authors by one or more author last initial facets
    contribRoleCode		list	restrict authors by one or more contrib role code facets
    companyCode		list	restrict authors by one or more company code facets
    author		list	restrict events by one or more author facets
    from		list	restrict events to those starting on or after the specified date
    to		list	restrict events to those starting on or before the specified date
    eventCityState		list	restrict events by one or more event city/state facets
    zip		string	restrict events based on proximitiy in miles to a zip code (must be specified with 'within')
    within		int	restrict events based on proximity in miles to a zip code (must be specified with 'zip')
    series.countMin		int	restrict series to only those that have at least this many works

  • GET listPredictiveSearchResults domains/{domain}/search/predictive

    return a search result based on a partial entry

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    docType		list	restrict by one or more document type facets

  • GET requestReload domains/{domain}/search/reload

    request that the search index be rebuilt

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    q		string	query to search for
    docType		list	restrict by one or more document type facets
    docTypeExclude		list	exclude one or more document type facets from the result
    ageRange		list	restrict by one or more age range facets
    award		list	restrict by one or more award facets
    categoryId		list	restrict by one or more categoryId facets
    categoryLabel		list	restrict by one or more categoryLabel facets
    division		list	restrict by one or more division facets
    format		list	restrict by one or more format facets -- these are really format family values such as 'Paperback'
    subformat		list	restrict by one or more subformat facets
    formatCode		list	restrict by one or more formatCode facets
    imprint		list	restrict by one or more imprint facets
    series		list	restrict by one or more series facets
    bestseller	true false	string	restrict to records flagged as bestsellers
    awardWinner	true false	string	restrict to records flagged as award winners
    comingSoon	true false	string	restrict to records flagged as coming soon
    newRelease	true false	string	restrict to records flagged as new releases
    forthcomingRelease	true false	string	restrict to records flagged as forthcoming releases
    authorLastInitial		list	restrict authors by one or more author last initial facets
    contribRoleCode		list	restrict authors by one or more contrib role code facets
    companyCode		list	restrict authors by one or more company code facets
    author		list	restrict events by one or more author facets
    from		list	restrict events to those starting on or after the specified date
    to		list	restrict events to those starting on or before the specified date
    eventCityState		list	restrict events by one or more event city/state facets
    zip		string	restrict events based on proximitiy in miles to a zip code (must be specified with 'within')
    within		int	restrict events based on proximity in miles to a zip code (must be specified with 'zip')
    series.countMin		int	restrict series to only those that have at least this many works

  • GET listViewSearchDisplay domains/{domain}/search/views/search-display

    return a search result with extra data elements

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    q		string	query to search for
    docType		list	restrict by one or more document type facets
    docTypeExclude		list	exclude one or more document type facets from the result
    ageRange		list	restrict by one or more age range facets
    award		list	restrict by one or more award facets
    categoryId		list	restrict by one or more categoryId facets
    categoryLabel		list	restrict by one or more categoryLabel facets
    division		list	restrict by one or more division facets
    format		list	restrict by one or more format facets -- these are really format family values such as 'Paperback'
    subformat		list	restrict by one or more subformat facets
    formatCode		list	restrict by one or more formatCode facets
    imprint		list	restrict by one or more imprint facets
    series		list	restrict by one or more series facets
    bestseller	true false	string	restrict to records flagged as bestsellers
    awardWinner	true false	string	restrict to records flagged as award winners
    comingSoon	true false	string	restrict to records flagged as coming soon
    newRelease	true false	string	restrict to records flagged as new releases
    forthcomingRelease	true false	string	restrict to records flagged as forthcoming releases
    authorLastInitial		list	restrict authors by one or more author last initial facets
    contribRoleCode		list	restrict authors by one or more contrib role code facets
    companyCode		list	restrict authors by one or more company code facets
    author		list	restrict events by one or more author facets
    from		list	restrict events to those starting on or after the specified date
    to		list	restrict events to those starting on or before the specified date
    eventCityState		list	restrict events by one or more event city/state facets
    zip		string	restrict events based on proximitiy in miles to a zip code (must be specified with 'within')
    within		int	restrict events based on proximity in miles to a zip code (must be specified with 'zip')
    series.countMin		int	restrict series to only those that have at least this many works

  • GET listViewPredictiveDisplay domains/{domain}/search/predictive/views/predictive-display

    return a predictive search result with extra data elements

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    q		string	query to search for
    docType		list	restrict by one or more document type facets
    docTypeExclude		list	exclude one or more document type facets from the result
    ageRange		list	restrict by one or more age range facets
    award		list	restrict by one or more award facets
    categoryId		list	restrict by one or more categoryId facets
    categoryLabel		list	restrict by one or more categoryLabel facets
    division		list	restrict by one or more division facets
    format		list	restrict by one or more format facets -- these are really format family values such as 'Paperback'
    subformat		list	restrict by one or more subformat facets
    formatCode		list	restrict by one or more formatCode facets
    imprint		list	restrict by one or more imprint facets
    series		list	restrict by one or more series facets
    bestseller	true false	string	restrict to records flagged as bestsellers
    awardWinner	true false	string	restrict to records flagged as award winners
    comingSoon	true false	string	restrict to records flagged as coming soon
    newRelease	true false	string	restrict to records flagged as new releases
    forthcomingRelease	true false	string	restrict to records flagged as forthcoming releases
    authorLastInitial		list	restrict authors by one or more author last initial facets
    contribRoleCode		list	restrict authors by one or more contrib role code facets
    companyCode		list	restrict authors by one or more company code facets
    author		list	restrict events by one or more author facets
    from		list	restrict events to those starting on or after the specified date
    to		list	restrict events to those starting on or before the specified date
    eventCityState		list	restrict events by one or more event city/state facets
    zip		string	restrict events based on proximitiy in miles to a zip code (must be specified with 'within')
    within		int	restrict events based on proximity in miles to a zip code (must be specified with 'zip')
    series.countMin		int	restrict series to only those that have at least this many works

• series

  • List Methods
  • Expand Methods

  • GET listSeries domains/{domain}/series

    return a list of series

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    series.countMin		int	restrict series to just those with a minimum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.countMax		int	restrict series to just those with a maximum number of works; for numbered series this only considers books that have been given series numbers; only considers ISBNs that have a cover image available
    series.numbered	true false	string	return numbered series (true) or unnumbered series (false)
    series.kids	true false	string	return series that have books with a Children or Young Adult consumer category (true) or don't (false)
    series.authorId		list	restrict series matching on the one or two primary authors that we've associated with the series; differs from 'authorId' which would test all the contributors attached to all the ISBN records that have the series code
    series.catUri		list	restrict series matching on the one or two primary categories that we've associated with the series; differs from 'catUri' which would test all the categories attached to all the ISBNS records that have the series code
    series.minPrintScore		int	restrict series to those where the most recent work's print score is at least a certain threshold
    series.ebookOriginal	true false	string	restrict series to those all the ISBN records with that series code have ORIGINAL_ISBN='ORIGINAL' and FORMAT_CODE='EL'
    sort		string	(default 'id') one of 'id', 'name', 'seriesDate', 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'

  • GET getSeries domains/{domain}/series/{seriesCode}

    return details about a series

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {seriesCode}		string	restrict by series code

  • GET listSeriesAuthors domains/{domain}/series/{seriesCode}/authors

    return the authors of a series

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    category		string	restrict results by one or more category facets (a concatenation of the CAT_SET_ID dash the CAT_URI e.g. 'CN-/fiction')
    onTour	true false	string	only return authors that have a confirmed event in the next 180 days
    eventDateFrom		date	only return authors that have a confirmed event on or after this date (MM/dd/yyyy)
    eventDateTo		date	only return authors that have a confirmed event on or before this date (MM/dd/yyyy)
    eventMinPrintScore		int	only return authors that have a confirmed event with a title that has a print score greater than this number; print score is a weighted total in print for all ISBNs in a work
    hideAuthorsWithNoPhoto	true false	string	only return authors that have a photo on file according to the table AC_IMAGE_VW
    authorLastInitial		string	restrict results by one or more last initial facets
    showBio	true false	string	only return authors that have bio content
    sort		string	(default 'id') one of 'id', 'authorLast' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {seriesCode}		string	restrict by series code

  • GET listSeriesCategories domains/{domain}/series/{seriesCode}/categories

    return the categories of a series

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict by category set ID
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'name', 'seq', 'weight' or 'random'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {seriesCode}		string	restrict by series code

  • GET listSeriesTitles domains/{domain}/series/{seriesCode}/titles

    return the titles in a series

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	either 'USD' or 'CAD'; only needed if sort=price
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', 'price', 'frontlistiest', 'random'. Note that if 'price' is specified, then you must also specify 'sortPriceTypeCode' with either 'USD' or 'CAD'
    dir		string	(default 'asc') either 'asc' or 'desc'
    {seriesCode}		string	restrict by series code

  • GET listSeriesWorks domains/{domain}/series/{seriesCode}/works

    return the works in a series

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)
    sort		string	(default 'id') one of 'id', 'onsale', 'title_onsale', 'title', 'authorLast', 'award', 'printScore', 'seriesNumber', random'; the 'title_onsale' is meant to sort on the on-sale date of the joined TITLE table rather than using the on-sale date of the work; for more information on 'printscore', see the Concepts page in the documentation of the same name.
    dir		string	(default 'asc') either 'asc' or 'desc'
    {seriesCode}		string	restrict by series code

• subseries

  • List Methods
  • Expand Methods

  • GET listSubseries domains/{domain}/subseries

    return a list of subseries

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases	true false	string	restrict results to titles that have the same on-sale date as the work
    hasSeriesNumber	true false	string	restrict results to titles that have their series number field populated
    minInPrint		long	works must have a LTD in-print across all titles greater than the specified number
    minPrintScore		long	same as 'minInPrint' except that the LTD in-print value is adjusted according to business rules (e.g. MM titles are not counted)
    awardMaxSeq		int	restrict results to award winners where the award sequence is less than or equal to the specified value
    ageRangeMin		int	restrict results to titles with an age range greater than or equal to the specified value
    ageRangeMax		int	restrict results to titles with an age range less than or equal to the specified value
    onSaleFrom		date	restrict results to titles with on-sale dates on or after the supplied date (MM/dd/yyyy)
    onSaleTo		date	restrict results to titles with on-sale dates on or before the supplied date (MM/dd/yyyy)
    workOnSaleFrom		date	restrict results to works with on-sale dates on or after the supplied date (MM/dd/yyyy)
    workOnSaleTo		date	restrict results to works with on-sale dates on or before the supplied date (MM/dd/yyyy)
    siteFilter		date	restrict results based on a named set of filters previously configured with the API developers (e.g. CommonReads)

  • GET getSubseries domains/{domain}/subseries/{subseries}

    return details about a subseries

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	when "sort=price", specify which pricetype_code (e.g. USD, CAD) is being used
    {subseries}		string	restrict by subseries description

• titles

  • List Methods
  • Expand Methods

  • GET listTitles domains/{domain}/titles

    return a list of titles

    Parameter	Value	Type	Description
    {domain}		string	restrict by web domain
    zoom		string	one or more link rels to be embedded in the response
    suppressLinks	true false	string	don't populate the "_links" elements
    suppressRecordCount	true false	string	don't populate the top-level "recordCount" element; this can be a big time savings for certain queries that are listing unusual populations
    preferLanguage		string	you may specify a single language code (e.g. 'E', 'SP') to have the first sort criteria be a boolean match against a TITLE or WORK record's language; this supersedes and is independent of the specified sort
    returnEmptyLists	true false	string	if true, the API will return an HTTP 200 with an empty data array when it would have returned an HTTP 404
    sortPriceTypeCode		string	either 'USD' or 'CAD'; only needed if sort=price
    start		int	(default=0) the index of the first row to be returned. Zero-based so 'start=10' indicates to start with the eleventh record.
    rows		int	(default=10) the number of rows to be returned. Set to zero to return all available rows.
    workId		long	restrict results based on one or more work IDs (see /works)
    isbn		long	restrict results based on one or more ISBNs (see /titles)
    authorId		long	restrict results based on one or more author IDs (see /authors)
    divisionCode		string	restrict results based on one or more division codes (see /divisions)
    imprintCode		string	restrict results based on one or more imprint codes (see /imprints)
    seriesCode		string	restrict results based on one or more series codes (see /series)
    format		string	restrict results based on one or more format codes (see /formats)
    formatFamily		string	restrict results based on one or more format family labels (one of Paperback, Hardcover, Ebook, Board Book, Boxed Set, Audio, App, or Merchandise)
    eventId		long	restrict results based on one or more event IDs (see /events)
    catId		long	restrict results based on one or more category IDs (see /categories)
    catUri		string	restrict results based on one or more category alternate identifiers
    catSetId		string	restrict category listings (either primary or secondary) to one or more category groups
    titleWebLinkAttr		int	results must contain a title weblink entry with one of the specified attrs
    authorWebLinkAttr		int	results must contain an author weblink entry with one of the specified attrs
    contribRoleCode		string	restrict by one or more contributor role codes (e.g. 'A', '4')
    consumerImprint		string	restrict results based on one or more consumer imprint values (e.g. 'BlueRiderPress','Penguin Audio')
    language		string	restrict results based on one or more language values (e.g. 'E', 'SP')
    catSeq		int	restrict results based on the sequencing of the categories assigned to title records
    productLine		string	restrict results based on one or more title product line values
    productType		string	restrict results based on one or more title product type values
    ageRange		string	restrict results based on one or more title age range values (e.g. '0005', '0408')
    salesRestriction		string	restrict results based on one or more sales restriction codes (e.g. '00', '01')
    saleStatus		string	restrict results based on one or more sale status codes (e.g. 'IP','OS')
    subFormat		string	restrict results based on one or more subformat codes (e.g. '001','BE')
    subSeries		string	restrict results based on one or more subseries values (e.g. 'The Rift')
    propertyName		string	restrict results based on one or more propertyname values (e.g. 'Sesame Street')
    subtitlePrefix		string	restrict results based on one or more matches against the start of the subtitle
    seriesNumber		number	restrict results based on one or more series number values (e.g. 1, 4)
    coverColor		string	restrict results based on the color of the cover
    ignoreIsbn		long	omit one or more ISBNs or records linked to those titles
    ignoreWork		long	omit one or more work IDs or records linked to those works
    ignoreAuthor		long	omit one or more author IDs or records linked to those authors
    ignoreFormatFamily		string	omit records linked to one or more format families
    ignoreFormatCode		string	omit records linked to one or more format codes
    ignoreCatUri		string	omit records linked to one or more category URIs -- currently only works with /categories, /titles and /works
    ignoreSeries		string	omit records linked to one or more series codes
    ignoreContribRole		string	omit records linked to one or more contrib role codes
    ignoreSubFormat		string	omit records linked to one or more sub format codes
    ignoreProductLine		string	omit records linked to one or more product line codes
    ignoreProductType		string	omit records linked to one or more product type codes
    ignoreDivisionCode		string	omit records linked to one or more division codes
    ignoreSaleStatus		string	omit records linked to one or more sale status codes
    ignoreSalesRestriction		string	omit records linked to one or more sales restriction codes
    showAwards	true false	string	results must have an awards record
    showBestsellers	true false	string	results must have an bestsellers record
    showNewReleases	true false	string	results must have an on-sale date between today and 180 days ago
    showComingSoon	true false	string	results must have an on-sale date between today and 90 days from now
    showPublishedBooks	true false	string	results must have an on-sale date of today or earlier
    showCovers	true false	string	titles must have a cover image
    showReadingGuides	true false	string	results must have reading guide content
    showTeachersGuides	true false	string	results must have teachers guide content
    showBoxBundles	true false	string	restrict results to include or exclude titles that have the 'Boxed Set' format family or are identified by their short title as E-book bundles
    showFlapCopy	true false	string	restrict results to include or exclude titles that have flap copy content populated
    showExcerpt	true false	string	restrict results to include or exclude titles that have an excerpt
    showNoTitleBlock	true false	string	restrict results to only include titles that have a NULL 'titleBlock' element
    showExportOnly	true false	string	restrict results based on the presence of the 'flag' value 'EXPORT' on the Title record
    showMovieTieIn	true false	string	restrict results based on the presence of the 'flag' value 'MOVIE_TIE_IN' on the Title record
    showTopselling	true false	string	only applicable to the sales display work view
    showFirstReleases