Ultimate Macro Wiki API Back to Wiki
On this page
Developer documentation v1

Give your bot the right answer.

Ask Ultimate Macro questions directly from your code. Get a documented answer with citations, or a clear not_found. No cloud browser, separate knowledge store or paid AI model required.

POST/api/wiki/v1/ask
Checking public Ask API…You can browse static guides while this loads.
01

How it works

It’s an ordinary HTTP API. Your application sends a question and receives JSON. The Wiki does the document lookup, not your bot.

1

Send a question

Make a POST request with JSON and a question field.

2

Check the result

Use status to distinguish a cited answer from not_found.

3

Show the source

Display answer and a link from citations. Never guess missing instructions.

02

Add it to your project

Choose your platform. Each example calls the Wiki API directly, with no browser automation or Wiki-specific npm/pip package.

Node.js 20+ / web

Ask from JavaScript

Use fetch from your app or bot.

    JavaScript
    Loading example…

    The source-backed Ask API is live. The examples call it directly; if it is temporarily unavailable, the static document fallback remains available.

    03

    Know what comes back

    The response is intentionally small. Answers cite published guides; unsupported questions stay unanswered.

    Answered
    {
      "status": "answered",
      "answer": "Documented steps…",
      "answer_type": "extractive",
      "citations": [{
        "title": "Relevant Wiki guide",
        "url": "https://ultmacro.xyz/wiki/?article=…",
        "version": "v1.3.x"
      }]
    }

    Illustrative shape, not an actual API response. Show the source URL with the answer.

    No documented answer
    {
      "status": "not_found",
      "answer": null,
      "citations": [],
      "message": "…"
    }

    HTTP 200 can still mean no answer. Never use related guides as proof of a solution.

    Optional version filters the documentation release. The default sourced mode is extractive, not AI-generated. HTTP errors (400/413/415/5xx) are separate from not_found.

    04

    Need access today?

    The static index and Markdown guide files already work without the Node API. Your bot can fetch them over HTTP, still without a cloud browser. This is document retrieval, not askWiki().

    Available nowCompact index + one guide at a time. No key, SDK or HTML scraping.
    Static JavaScript example
    Loading fallback example…
    Open compact JSON index
    05

    Browse published guides

    For human browsing and testing the document index. Bots should use the API or the static JSON, not scrape this page.

    Results

    Loading…

    Loading published guides.

    06

    Reference & downloads