Authentication
The API requires a key. If you would like to make use of the API contact us to request a key.
Usertoken API
Get Usertoken API endpoint
Get Usertoken API endpoint
For endpoints which require a logged in user, account validation is provided through checks against a supplied usertoken which has a limited lifespan. The Get Usertoken API Endpoint requires the following parameters in a POST Request:
Account API
Register API endpoint
Get Usertoken API endpoint
The Register API Endpoint requires the following parameters in a POST Request:
Activity API
Activity API endpoint
The Activity API Endpoint requires the following parameters in a POST Request:
- accesskey
- quantityofrecords
- pagesize
The Activity API Endpoint requires at least 1 of the following parameters:
- contributors
- publishers
- keywords
Example queries
Example query - 100 activity items matching the keyword of "dog".
Example query - 100 activity items matching the keyword of "dog" or the publisher Quarto.
Output
The API outputs JSON data, and returns:
ActivityID
A unique ID for the activity item.
ActivityDate
The date the activity item was set to display from e.g. 2018-01-01T00:00:00.
ActivityText
Text content of the activity item, this can include HTML mark-up.
Title
The title of the activity item.
HashTags
Suggested hashtags associated with the activity item.
ActivityJacketImage
The URL of an image associated with the activity item.
Isbn
If the activity is associated with a book, the isbn of the book.
ActivitySourceType
The source type for the activity. This could be Generated, Web or Twitter
ActivityType
The type of activity as given by Another Read.
ContributorList
A list of contributors (authors and illustrators) associated with the activity item, each entry includes ContributorID.
BookLookup
A lookup of book details indexed by Isbn.
ContributorLookup
A lookup of contributor details indexed by ContributorID.
Suggestions API
Suggestions API endpoint
The Suggestions API Endpoint requires the following parameters in a POST Request:
- usertoken
- accesskey
- includestackbooks
- includestackbookratings
- onlyrecommendationswithbooks
The following parameters are optional:
- activitystartdate
- activityenddate
- activitytype
- permitdynamicrecommendations
- pagesize
- pagenumber
Example query
Stacks API
Get Stacks API endpoint
The Get Stacks API Endpoint requires the following parameters in a POST Request:
- usertoken
- accesskey
- includebooks
- includeratings
The following parameters are optional:
Example query
Delete Stacks API endpoint
Delete Stacks API endpoint
The Delete Stacks API Endpoint requires the following parameters in a POST Request:
- usertoken
- accesskey
- stackidlist
Example query
Stack Search API endpoint
Stack Search API endpoint
The Stack Search API Endpoint requires the following parameters in a POST Request:
- usertoken
- accesskey
- search
- quantityofrecords
- includeratings
Example query
Get Stack Admin List API endpoint
Get Stack Admin List API endpoint
The Get Stack Admin List API Endpoint requires the following parameters in a POST Request:
- usertoken
- accesskey
- pagenumber
- pagesize
- includebooks
- includeratings
The following parameters are optional:
Example query
Example query (showing only default stacks)
Example query (hiding default stacks)
Stack API
Get Stack API endpoint
The Get Stack API Endpoint requires the following parameters in a POST Request:
- usertoken
- accesskey
- stackid
- includebooks
- includeratings
The following parameters are optional:
Example query
Save Stack API endpoint
The save Stack API Endpoint requires the following URL parameters in a POST Request:
- usertoken
- accesskey
- stacktitle
- isbnlist
- ispublished
The following parameters are optional:
Example stack creation query
Example update stack query
Edit Stack API endpoint
The Edit Stack API Endpoint requires the following parameters in a POST Request:
- usertoken
- accesskey
- stackid
- includeratings
Example query