LiveCode APIdocs.livecode.com ↗
Access LiveCode Script documentation via API. Look up 631 commands, 606 functions, control structures, and more with list_entries and get_entry endpoints.
What is the LiveCode API?
The LiveCode Docs API provides structured access to the full LiveCode Script language reference across two endpoints. Using list_entries, you can retrieve all items within a category — Commands alone contains 631 entries — and with get_entry you get complete documentation for any individual entry including syntax, parameters, description, examples, and related references.
curl -X GET 'https://api.parse.bot/scraper/9454d259-7587-4622-a96b-c53724cb84ad/list_entries?category=Commands' \ -H 'X-API-Key: $PARSE_API_KEY'
Typed, relational, agent-ready
A generated client with real types, enums, and the links between objects — the structure a flat JSON response can't carry. Autocompletes in your editor and reads cleanly to coding agents.
- Fully typed · autocompletes
- Objects link to objects
- Typed errors & pagination
Typed Python client. Set up the SDK in your uv project, then pull this API’s typed client:
uv add parse-sdk uv run parse init uv run parse add --marketplace docs-livecode-com-api
uv run parse add --marketplace pulls a pinned snapshot of this canonical API — it won’t change underneath you. To customize it, subscribe and swap to your own copy.
"""Walkthrough: LiveCodeDocs SDK — bounded, re-runnable; every call capped."""
from parse_apis.docs_livecode_com_api import LiveCodeDocs, Category, EntryNotFound
client = LiveCodeDocs()
# List entries in a category
for entry in client.doccategory("Control Structures").list(limit=3):
print(entry.name, entry.url)
# Get full documentation for a specific entry
detail = client.entries.get(category=Category.COMMANDS, name="add")
print(detail.name, detail.type, detail.summary)
# Typed error handling for a nonexistent entry
try:
missing = client.entries.get(category=Category.FUNCTIONS, name="nonexistent_xyz")
print(missing.name)
except EntryNotFound as e:
print("not found:", e.name)
print("exercised: doccategory.list / entries.get")
Lists all entries in a given LiveCode Script documentation category. Returns entry names and their documentation paths. Categories include Commands (631 items), Functions (606 items), Control Structures (18 items), Constants, Glossary, Keywords, Libraries, Messages, Objects, Operators, Properties, Widgets, and com.livecode.language.
| Param | Type | Description |
|---|---|---|
| categoryrequired | string | The LiveCode Script documentation category to list entries for. |
{
"type": "object",
"fields": {
"count": "Total number of entries in this category",
"entries": "Array of entry objects with name and url fields",
"category": "The category name"
},
"sample": {
"data": {
"count": 18,
"entries": [
{
"url": "/docs/LiveCode Script/Control Structures/after",
"name": "after"
},
{
"url": "/docs/LiveCode Script/Control Structures/before",
"name": "before"
},
{
"url": "/docs/LiveCode Script/Control Structures/if",
"name": "if"
}
],
"category": "Control Structures"
},
"status": "success"
}
}About the LiveCode API
Endpoints and Coverage
The API exposes two endpoints. list_entries accepts a category parameter and returns a count, a category label, and an entries array where each object includes a name and a url. Supported categories include Commands (631 items), Functions (606 items), Control Structures (18 items), as well as Constants, Glossary, Keywords, Libraries, Messages, Objects, and Operators.
Entry Detail
get_entry takes a name and category and returns the full documentation record for that entry. The response includes a type field (e.g. command, function, control structure), a syntax string with parameter placeholders, a summary one-liner, a full description, an examples array with working code samples, a parameters array (each with name, type, and description), and a related field listing connected commands, functions, keywords, and glossary terms.
Practical Usage Pattern
The typical flow is to call list_entries for a category to enumerate available names and their documentation paths, then pass individual name and category values to get_entry to retrieve the structured detail. Entry names from list_entries map directly to the name input of get_entry, so the two endpoints chain naturally for bulk lookups or targeted queries.
Source Context
Docs.livecode.com is the official LiveCode documentation site. LiveCode does not publish a public REST API for its documentation; this API provides the only programmatic way to query the reference content at scale.
The LiveCode API is a managed, monitored endpoint for docs.livecode.com — not a raw scraper you maintain. Every endpoint is automatically health-checked on a schedule, and when docs.livecode.com changes and a check fails, the API is automatically queued for repair and re-verified. It is built to keep working as the site underneath it changes.
This isn't an official docs.livecode.com API — it's an independent, maintained REST wrapper over public data. Where the source has no official API (or only a limited one), Parse gives you a stable contract over a source that never promised one, and keeps it current. Need a new endpoint or field? You can revise it yourself in plain English and the agent rebuilds it against the live site in minutes — contributing the change back to the shared API is free.
Will this API break when the source site changes?+
Is this an official API from the source site?+
Can I fix or extend this API myself if I need a new endpoint or field?+
What happens if I call an endpoint that has an issue?+
- Build an IDE plugin that surfaces LiveCode command syntax and parameter descriptions inline while coding.
- Generate a local, searchable offline documentation index by iterating through all categories with list_entries.
- Automate detection of deprecated or changed functions by diffing get_entry description fields over time.
- Populate a chatbot or AI assistant with structured LiveCode reference data for answering scripting questions.
- Create cross-reference tooling that maps related entries using the related field returned by get_entry.
- Produce structured documentation exports (JSON, HTML, Markdown) for internal LiveCode developer wikis.
- Validate LiveCode scripts by checking parameter counts and types from get_entry syntax fields programmatically.
| Tier | Price | Credits/month | Rate limit |
|---|---|---|---|
| Free | $0/mo | 100 | 5 req/min |
| Hobby | $30/mo | 1,000 | 20 req/min |
| Developer | $100/mo | 5,000 | 100 req/min |
One credit = one API call regardless of which marketplace API you call. Exceeding the rate limit returns a 429 response. Authenticate with the X-API-Key header.