GET /text-services/word-coordinates-service

loc.gov:library-of-congress-apis

Summary: Get word coordinates and OCR text
Operation ID: getWordCoordinates
Auth: none
Description

Retrieve OCR text and word coordinates for a document segment. Supports plain text, ALTO XML, and DjVu formats.

Parameters (6)

byte_range (string, query, optional)

Byte range to retrieve in format 'n-m'

format (string, query, required)

OCR format: 'plain_text', 'alto_xml', 'djvu_json', or 'djvu_xml'

Constraints: {'enum': ['plain_text', 'alto_xml', 'djvu_json', 'djvu_xml']}

full_text (integer, query, optional)

Set to '1' to return full OCR text

Constraints: {'enum': [0, 1]}

q (string, query, optional)

Search query for context snippets

relevant_snippet (integer, query, optional)

Set to '1' to return relevant text snippets around search matches

Constraints: {'enum': [0, 1]}

segment (string, query, required)

Path to the content segment (can be repeated for multiple segments)

No probe data for this endpoint yet.