Do We Have It API
Book "do we have it" can be queried by either ISBN
or ASIN
. There are plans to also support title
.
Either an ASIN or ISBN can be submitted for the isbn
key. The API will detect whether the value is an ASIN or an ISBN.
When the API request if received by the IA server, the server is looking for different identifiers that may be related to the queried identifier, for example: related ISBNs or ASINs, related items that exist in IA’s collections, etc.
Based on the data that the IA has on these related items, it calculates an response status and responds with the following fields:
{
status: "ok",
response: 0,
message: "we have this book",
ia_identifiers:
{
ia_identifier: "lorem00ipsum",
score: 1
},
response_time: 0.1064
}
status
Value | Information |
---|---|
OK | The input string seems to be valid |
Error | There's an error with the input string or the service |
response/message
Response | Message |
---|---|
-1 | invalid asin or isbn |
0 | we have this book |
1 | we don't have this book |
ia_identifiers - An array of globally unique IDs of items on archive.org that are related to the input (either have the same asin/isbn/oclc/lccn or have a related asin/isbn/oclc/lccn)
response time - The time it took for IA’s server to generate the response
score - 1 if the book is an exact match, 0.5 if it's a related match
Debug Info
Additional fields are returned when &debug=true is added to the end of the query
{
status: "ok",
response: 0,
message: "we have this book",
ia_identifiers:
[
ia_identifier: "9783791535661",
score: 1
],
books:
{
9783791535661:
{
metadata:
{
title: "DWWIAPI4Dummies",
imagecount: "1",
isbn: "9783791535661",
identifier: "DWNIAPI18R3",
mediatype: "texts",
creator: "DWNI, API",
related-external-id:[
"urn:isbn:3833722509",
"urn:asin:276776144",
"urn:oclc:723876752",
"urn:lccn:836890281"
]
},
}
},
component_response_times:
{
search: 0.0531,
sort: 0.0001
},
query: "mediatype:texts AND (isbn:TESTISBN00018 OR related-external-id:"urn:isbn:TESTISBN00018")",
response_time: 0.0749
}
books - contains further metadata and internal algorithm results about the items from ia_identifiers
title - the name of the item
imagecount - number of scanned/uploaded image files that are associated to this book
isbn - ISBN/ASIN that associated to this book
creator - Writer/Illustrator/etc. that are related to this book
related-external-id - if available, an array of other asin/isbn/oclc/lccn that are related to this book, available in urn format
query - the query that’s used internally by the IA system to create this response