Skip to content
RefBytes A–Z Databases Start a trial
Menu
07

Show the list on your own website, or read it as JSON.

API and embeddable widget

Plus plans (and every trial) can read the database list as JSON or drop a ready-made widget into an existing website. Both use a token from API & widget in the admin. Only databases patrons can already see are ever returned.

The widget

Paste this where the list should appear:

<div data-refbytes-az data-token="az_…"></div>
<script src="https://yourlibrary.refbytesaz.com/widget.js" defer></script>

It renders a search box, subject/type/access filters, and the cards in your brand color, with every link going through the same tracked redirect as the main page so clicks still count. Optional attributes: data-subject="genealogy" locks a subject, data-list="spanish-resources" shows one of your lists (by its handle, in the list's order), data-limit="12" caps the list, data-hide-filters="true" shows search only.

If you set allowed origins on the token, the widget only works on those sites.

The API

GET /api/v1/library
GET /api/v1/databases?q=&subject=&type=&access=&audience=&featured=1&per_page=100
GET /api/v1/databases/{handle}
GET /api/v1/subjects
GET /api/v1/types

The full interactive reference, with every parameter and example responses, is at /api/docs (OpenAPI JSON at /api/docs.json).

Send the token as Authorization: Bearer az_… or ?token=az_…. Responses are JSON with a data key; list endpoints are paginated. 120 requests per minute per token. Each database includes links.open (tracked, proxied) and links.details.