universalis-mcp-server 0.2.0 → 0.2.1

package/README.md

@@ -43,6 +43,11 @@ All tools support `response_format` as `markdown` or `json`.
 
 Best-deals is excluded (premium gated + inconsistent API validation).
 
+### Guides (Wiki snapshots)
+
+- `wiki_list_pages`: List curated wiki pages for Saddlebag and Universalis guides.
+- `wiki_get_page`: Fetch a wiki page by slug for extra context.
+
 ### Reference data (Universalis)
 
 - `universalis_list_worlds`: List worlds with pagination.
@@ -90,6 +95,12 @@ pnpm install
 pnpm build
 ```
 
+To refresh curated wiki snapshots:
+
+```bash
+pnpm update-wiki-docs
+```
+
 ## Run (stdio)
 
 ```bash
@@ -121,6 +132,8 @@ If you change code, re-run `pnpm build` and restart the MCP connection.
 - `UNIVERSALIS_TIMEOUT_MS`: Request timeout for Universalis (default: 30000).
 - `XIVAPI_TIMEOUT_MS`: Request timeout for XIVAPI (default: 30000).
 - `SADDLEBAG_TIMEOUT_MS`: Request timeout for Saddlebag (default: 30000).
+- `WIKI_FETCH_MODE`: `local` (default) for snapshot files or `live` to fetch from GitHub.
+- `WIKI_REFRESH_TTL_MS`: Cache TTL for live wiki fetches (default: 3600000).
 - `XIVAPI_LANGUAGE`: Default XIVAPI language (default: `en`).
 - `XIVAPI_VERSION`: Default XIVAPI version (default: `latest`).
 
@@ -129,3 +142,5 @@ If you change code, re-run `pnpm build` and restart the MCP connection.
 - Rate limits are enforced client-side for Universalis and XIVAPI.
 - Tools support `response_format` as `markdown` or `json`.
 - Some Saddlebag endpoints proxy Universalis data; avoid excessive polling.
+- Wiki pages are curated snapshots stored in `docs/wiki`.
+- Set `WIKI_FETCH_MODE=live` to refresh wiki pages at runtime using the allowlisted index.

package/data/materia.json

@@ -1,5 +1,5 @@
 {
-  "generated_at": "2026-01-11T21:38:40.756Z",
+  "generated_at": "2026-01-11T22:27:50.340Z",
   "xivapi_version": "309a1e90d28b6bc6",
   "categories": {
     "combat": {

package/dist/index.js

@@ -9,6 +9,7 @@ import { registerMarketTools } from "./tools/market.js";
 import { registerReferenceTools } from "./tools/reference.js";
 import { registerSaddlebagTools } from "./tools/saddlebag.js";
 import { registerStatsTools } from "./tools/stats.js";
+import { registerWikiTools } from "./tools/wiki.js";
 import { registerWorkflowTools } from "./tools/workflows.js";
 function toNumber(value) {
     if (!value)
@@ -37,6 +38,7 @@ async function main() {
     registerStatsTools(server, clients);
     registerLookupTools(server, clients);
     registerSaddlebagTools(server, clients);
+    registerWikiTools(server);
     registerWorkflowTools(server, clients);
     server.registerPrompt("universalis_usage_guide", {
         title: "Universalis Usage Guide",

package/dist/instructions.js

@@ -41,6 +41,10 @@ Saddlebag tools (FFXIV):
 - saddlebag_get_craftsim: crafting profitability scan (use max_results to limit payloads).
 - saddlebag_get_blog_description: item description text lookup.
 
+Wiki tools:
+- wiki_list_pages: list curated Saddlebag/Universalis guide pages.
+- wiki_get_page: fetch a wiki page by slug for extra context.
+
 Notes:
 - world_dc_region accepts a world name/ID, data center name, or region.
 - response_format defaults to markdown; use json for structured processing.
@@ -53,4 +57,6 @@ Notes:
 - Saddlebag best-deals is excluded (premium gated + inconsistent API validation).
 - Some Saddlebag endpoints call Universalis directly; be mindful of rate limits.
 - saddlebag_get_raw_stats supports item_ids = -1 for all items and can return very large payloads.
+- Wiki pages are curated snapshots; refresh with scripts/update-wiki-docs.mjs as needed.
+- Set WIKI_FETCH_MODE=live to fetch allowlisted wiki pages from GitHub (cached by WIKI_REFRESH_TTL_MS).
 `;

package/dist/tools/wiki.js

@@ -0,0 +1,176 @@
+import { z } from "zod";
+import { readFile } from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { BaseOutputSchema, ResponseFormatSchema } from "../schemas/common.js";
+import { buildToolResponse } from "../utils/format.js";
+import { CHARACTER_LIMIT } from "../constants.js";
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const wikiRoot = path.resolve(__dirname, "..", "..", "docs", "wiki");
+const wikiIndexPath = path.join(wikiRoot, "index.json");
+const WIKI_FETCH_MODE = (process.env.WIKI_FETCH_MODE ?? "local").toLowerCase();
+const WIKI_REFRESH_TTL_MS = Number.parseInt(process.env.WIKI_REFRESH_TTL_MS ?? "", 10);
+const DEFAULT_WIKI_REFRESH_TTL_MS = 1000 * 60 * 60;
+const wikiTtlMs = Number.isFinite(WIKI_REFRESH_TTL_MS)
+    ? WIKI_REFRESH_TTL_MS
+    : DEFAULT_WIKI_REFRESH_TTL_MS;
+let wikiIndexCache = null;
+const wikiLiveCache = new Map();
+function rawWikiUrl(repo, slug) {
+    return `https://raw.githubusercontent.com/wiki/${repo}/${slug}.md`;
+}
+async function loadWikiIndex() {
+    if (wikiIndexCache)
+        return wikiIndexCache;
+    const raw = await readFile(wikiIndexPath, "utf8");
+    const parsed = JSON.parse(raw);
+    wikiIndexCache = parsed;
+    return parsed;
+}
+function resolveSource(index, sourceId) {
+    return index.sources.find((source) => source.id === sourceId);
+}
+function formatSources(index, sourceId) {
+    const sources = sourceId
+        ? index.sources.filter((source) => source.id === sourceId)
+        : index.sources;
+    return sources.map((source) => ({
+        id: source.id,
+        title: source.title,
+        base_url: source.base_url,
+        pages: source.pages.map((page) => ({
+            slug: page.slug,
+            title: page.title,
+            description: page.description,
+            url: page.url,
+        })),
+    }));
+}
+export function registerWikiTools(server) {
+    server.registerTool("wiki_list_pages", {
+        title: "List Wiki Pages",
+        description: "List curated wiki pages available for Saddlebag and Universalis guides.",
+        inputSchema: z
+            .object({
+            source: z.string().min(1).optional().describe("Wiki source ID (saddlebag or universalis)."),
+            response_format: ResponseFormatSchema,
+        })
+            .strict(),
+        outputSchema: BaseOutputSchema,
+        annotations: {
+            readOnlyHint: true,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: true,
+        },
+    }, async ({ source, response_format }) => {
+        const index = await loadWikiIndex();
+        const availableSources = index.sources.map((item) => item.id);
+        if (source && !availableSources.includes(source)) {
+            throw new Error(`Unknown wiki source '${source}'. Available: ${availableSources.join(", ")}`);
+        }
+        const data = { sources: formatSources(index, source) };
+        const totalPages = data.sources.reduce((sum, item) => sum + item.pages.length, 0);
+        return buildToolResponse({
+            title: "Wiki Pages",
+            responseFormat: response_format,
+            data,
+            meta: { source: "wiki", total_pages: totalPages },
+        });
+    });
+    server.registerTool("wiki_get_page", {
+        title: "Get Wiki Page",
+        description: "Fetch a curated wiki page by slug.",
+        inputSchema: z
+            .object({
+            source: z.string().min(1).describe("Wiki source ID (saddlebag or universalis)."),
+            page: z.string().min(1).describe("Wiki page slug from wiki_list_pages."),
+            max_chars: z
+                .number()
+                .int()
+                .min(200)
+                .max(CHARACTER_LIMIT)
+                .default(20000)
+                .describe("Maximum characters to return (default: 20000)."),
+            response_format: ResponseFormatSchema,
+        })
+            .strict(),
+        outputSchema: BaseOutputSchema,
+        annotations: {
+            readOnlyHint: true,
+            destructiveHint: false,
+            idempotentHint: true,
+            openWorldHint: true,
+        },
+    }, async ({ source, page, max_chars, response_format }) => {
+        const index = await loadWikiIndex();
+        const resolvedSource = resolveSource(index, source);
+        if (!resolvedSource) {
+            const availableSources = index.sources.map((item) => item.id);
+            throw new Error(`Unknown wiki source '${source}'. Available: ${availableSources.join(", ")}`);
+        }
+        const match = resolvedSource.pages.find((entry) => entry.slug === page);
+        if (!match) {
+            const availablePages = resolvedSource.pages.map((entry) => entry.slug).join(", ");
+            throw new Error(`Unknown wiki page '${page}'. Available: ${availablePages}`);
+        }
+        const filePath = path.join(wikiRoot, resolvedSource.id, match.file);
+        const cacheKey = `${resolvedSource.id}:${match.slug}`;
+        let content = "";
+        let fetchMode = "local";
+        let cacheHit = false;
+        if (WIKI_FETCH_MODE === "live") {
+            fetchMode = "live";
+            const cached = wikiLiveCache.get(cacheKey);
+            const now = Date.now();
+            if (cached && now - cached.fetchedAt < wikiTtlMs) {
+                content = cached.content;
+                cacheHit = true;
+            }
+            else {
+                try {
+                    const url = rawWikiUrl(resolvedSource.repo, match.slug);
+                    const res = await fetch(url);
+                    if (!res.ok) {
+                        throw new Error(`Failed to fetch wiki page (${res.status})`);
+                    }
+                    content = await res.text();
+                    wikiLiveCache.set(cacheKey, { content, fetchedAt: now });
+                }
+                catch (error) {
+                    fetchMode = "fallback_local";
+                    content = await readFile(filePath, "utf8");
+                }
+            }
+        }
+        else {
+            content = await readFile(filePath, "utf8");
+        }
+        let outputContent = content;
+        let truncated = false;
+        if (outputContent.length > max_chars) {
+            truncated = true;
+            outputContent = `${outputContent.slice(0, max_chars)}\n\n... truncated ...`;
+        }
+        const data = {
+            source: resolvedSource.id,
+            slug: match.slug,
+            title: match.title,
+            url: match.url,
+            content: outputContent,
+        };
+        const summaryLines = truncated ? [`Truncated to ${max_chars} characters.`] : undefined;
+        return buildToolResponse({
+            title: "Wiki Page",
+            responseFormat: response_format,
+            data,
+            meta: {
+                source: "wiki",
+                truncated,
+                fetch_mode: fetchMode,
+                cache_hit: cacheHit,
+            },
+            summaryLines,
+        });
+    });
+}

package/docs/wiki/index.json

@@ -0,0 +1,153 @@
+{
+  "sources": [
+    {
+      "id": "saddlebag",
+      "title": "Saddlebag Exchange Wiki",
+      "repo": "ff14-advanced-market-search/saddlebag-with-pockets",
+      "base_url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki",
+      "pages": [
+        {
+          "slug": "Item-categories-ids-and-list",
+          "file": "item-categories-ids-and-list.md",
+          "title": "Item categories ids and list",
+          "description": "Category filter IDs used by Saddlebag tools.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Item-categories-ids-and-list"
+        },
+        {
+          "slug": "FFXIV-job-category-ids",
+          "file": "ffxiv-job-category-ids.md",
+          "title": "FFXIV job category ids",
+          "description": "Job IDs used by crafting and shopping list tools.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-job-category-ids"
+        },
+        {
+          "slug": "How-to-use-the-FFXIV-crafting-profit-simulator-(craftsim)",
+          "file": "how-to-use-the-ffxiv-crafting-profit-simulator-craftsim.md",
+          "title": "How to use the FFXIV crafting profit simulator",
+          "description": "Craftsim workflow and parameter guidance.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-use-the-FFXIV-crafting-profit-simulator-(craftsim)"
+        },
+        {
+          "slug": "How-to-trade-using-our-FFXIV-Market-Overview",
+          "file": "how-to-trade-using-our-ffxiv-market-overview.md",
+          "title": "How to trade using the FFXIV market overview",
+          "description": "Marketshare overview workflow and filters.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/How-to-trade-using-our-FFXIV-Market-Overview"
+        },
+        {
+          "slug": "FFXIV-Advanced-Undercut-Alert-Options",
+          "file": "ffxiv-advanced-undercut-alert-options.md",
+          "title": "FFXIV advanced undercut alert options",
+          "description": "Advanced undercut alert parameters.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Advanced-Undercut-Alert-Options"
+        },
+        {
+          "slug": "FFXIV-Sale-Alerts",
+          "file": "ffxiv-sale-alerts.md",
+          "title": "FFXIV sale alerts",
+          "description": "Sale alert inputs and usage.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Sale-Alerts"
+        },
+        {
+          "slug": "Allagan-Tools-Inventory-Analysis",
+          "file": "allagan-tools-inventory-analysis.md",
+          "title": "Allagan tools inventory analysis",
+          "description": "Allagan Tools data import and alerts.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Allagan-Tools-Inventory-Analysis"
+        },
+        {
+          "slug": "FFXIV-Experimental-Discount-Price-Sniper",
+          "file": "ffxiv-experimental-discount-price-sniper.md",
+          "title": "FFXIV experimental discount price sniper",
+          "description": "Discount price sniper guide and thresholds.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Experimental-Discount-Price-Sniper"
+        },
+        {
+          "slug": "FFXIV-Sale-Leads",
+          "file": "ffxiv-sale-leads.md",
+          "title": "FFXIV sale leads",
+          "description": "Sale leads ideas and examples.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Sale-Leads"
+        },
+        {
+          "slug": "TLDR:-How-to-earn-gil-with-cross-server-trading",
+          "file": "tldr-how-to-earn-gil-with-cross-server-trading.md",
+          "title": "TLDR: How to earn gil with cross server trading",
+          "description": "Condensed workflow for cross-server trading.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/TLDR:-How-to-earn-gil-with-cross-server-trading"
+        },
+        {
+          "slug": "API-Call-Guide",
+          "file": "api-call-guide.md",
+          "title": "API call guide",
+          "description": "General API notes and examples.",
+          "url": "https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/API-Call-Guide"
+        }
+      ]
+    },
+    {
+      "id": "universalis",
+      "title": "Universalis Guides Wiki",
+      "repo": "Universalis-FFXIV/guides",
+      "base_url": "https://github.com/Universalis-FFXIV/guides/wiki",
+      "pages": [
+        {
+          "slug": "API-App-Overview",
+          "file": "api-app-overview.md",
+          "title": "API app overview",
+          "description": "Universalis API overview and usage context.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/API-App-Overview"
+        },
+        {
+          "slug": "How-to-search-for-items-on-Universalis-and-Saddlebag-Exchange",
+          "file": "how-to-search-for-items-on-universalis-and-saddlebag-exchange.md",
+          "title": "How to search for items on Universalis and Saddlebag Exchange",
+          "description": "Item search workflow notes.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/How-to-search-for-items-on-Universalis-and-Saddlebag-Exchange"
+        },
+        {
+          "slug": "How-to-make-Universalis-Lists",
+          "file": "how-to-make-universalis-lists.md",
+          "title": "How to make Universalis lists",
+          "description": "Universalis list creation guide.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/How-to-make-Universalis-Lists"
+        },
+        {
+          "slug": "How-to-setup-Universalis-Alerts",
+          "file": "how-to-setup-universalis-alerts.md",
+          "title": "How to setup Universalis alerts",
+          "description": "Alert setup and usage guidance.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/How-to-setup-Universalis-Alerts"
+        },
+        {
+          "slug": "Navigating-an-item-overview-on-Universalis",
+          "file": "navigating-an-item-overview-on-universalis.md",
+          "title": "Navigating an item overview on Universalis",
+          "description": "Item overview explanation and metrics.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/Navigating-an-item-overview-on-Universalis"
+        },
+        {
+          "slug": "How-to-use-Universalis-Favorites",
+          "file": "how-to-use-universalis-favorites.md",
+          "title": "How to use Universalis favorites",
+          "description": "Favorites workflow and recommendations.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/How-to-use-Universalis-Favorites"
+        },
+        {
+          "slug": "How-to-help-update-the-data-on-Universalis%3F",
+          "file": "how-to-help-update-the-data-on-universalis.md",
+          "title": "How to help update the data on Universalis",
+          "description": "Contributor guidance for data updates.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/How-to-help-update-the-data-on-Universalis%3F"
+        },
+        {
+          "slug": "Interactive-Tutorials",
+          "file": "interactive-tutorials.md",
+          "title": "Interactive tutorials",
+          "description": "Interactive tutorial index.",
+          "url": "https://github.com/Universalis-FFXIV/guides/wiki/Interactive-Tutorials"
+        }
+      ]
+    }
+  ]
+}

package/docs/wiki/saddlebag/allagan-tools-inventory-analysis.md

@@ -0,0 +1,94 @@
+Our Allagan Data tool will analyze your inventory and items you are selling on the marketboard.
+
+https://saddlebagexchange.com/allagan-data 
+
+This tool will do the following:
+
+1. Show you valuable items in your inventory you may have forgotten about
+2. Create the json data for our sale alerts
+3. Adds a 2nd method of generating json for undercut alerts (we still recommend [the original method](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Undercut-Alerts---Alpha-version) for more [advanced filtering](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/FFXIV-Advanced-Undercut-Alert-Options))
+4. Shows you what items are out of date on universalis, that you should update before leaving the marketboard.
+
+Quicklinks:
+- [How to use the Allgan Data import](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Allagan-Tools-Inventory-Analysis#how-to-use-the-allgan-data-import)
+- [How to use the in bags report](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Allagan-Tools-Inventory-Analysis#in-bags-report)
+- [How to update items for "out of date data"](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Allagan-Tools-Inventory-Analysis/#out-of-date-data)
+- [How to get json data for sale and undercut alerts](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/wiki/Allagan-Tools-Inventory-Analysis#sale-and-undercut-alert-json-data)
+
+## How to use the Allgan Data import
+
+1. Make sure you have Dalamund Plugins and Allagan tools installed and that you have the following columns enabled.
+
+![image](https://user-images.githubusercontent.com/17516896/233134089-43ac28d4-a66a-45b1-a82c-73fc504e658f.png)
+
+Make sure source, location, quantity and type are enabled
+
+![image](https://user-images.githubusercontent.com/17516896/235263844-cb4916c5-335e-466e-84bd-04bf112f6bac.png)
+
+
+2. On the top left menu click > Edit > Copy List Contents > JSON Format
+
+![image](https://github.com/user-attachments/assets/476deec1-ab2d-4d84-b367-7b09a313a9d3)
+
+
+3. Make sure your server is set in the website settings, go to https://saddlebagexchange.com/allagan-data, then paste in the json data from Allagan Tools and hit search:
+
+![image](https://user-images.githubusercontent.com/17516896/233134974-3bbe02e9-2135-4063-a0e4-e1ada8350121.png)
+
+4. Review the report fields
+
+![image](https://user-images.githubusercontent.com/17516896/233135238-f4cd7412-5ae2-4f6b-97de-faa28c179ee7.png)
+
+
+## In Bags Report
+
+The in bags report is very simple it shows you the most valuable items sitting in your inventory you may have forgotten about.  These are very good items to list on the marketboard:
+
+![image](https://user-images.githubusercontent.com/17516896/233135654-297610a4-ed5f-4840-97f2-bd373f106aa2.png)
+
+## Out of Date Data
+
+When an item shows up in the `Out of date` lists for undercuts or sale alerts, it means that universalis does not see the data we need for our alerts. This could also mean that you are already undercut or have already sold these items.
+
+![image](https://user-images.githubusercontent.com/17516896/233136822-c8b9b4fb-a86e-4dfd-8e40-9f344bc6c5bd.png)
+
+To update this you just need to go to the marketboard (while Dalamund Plugins is running) and view the listings for any items that show up in our lists:
+
+![image](https://user-images.githubusercontent.com/17516896/233136282-47e399f3-db11-4d30-a16e-3e23a62a1d19.png)
+
+To make this easier I recommend adding all items you are selling to your favorites list so you can click through them instead of pasting the names into your marketboard search:
+
+![image](https://user-images.githubusercontent.com/17516896/233137655-d813b06c-a1a5-484b-a449-054b7d5a9eed.png)
+
+After you do this and all items are up to date then the list will be empty and you are ready to use the sale alerts and undercut alerts:
+
+![image](https://user-images.githubusercontent.com/17516896/233136947-d1dea61e-1570-4869-a508-e87a59787b5b.png)
+
+
+## Sale and Undercut alert json data
+
+If you click the copy to clipboard buttons for the undercut or sale alerts you will get data similar to the following to be used in our discord with slash commands.
+
+Sale alert (use with `/ff sale-register`):
+```
+{
+  "item_ids":[21826,20744,35562,2731,7148,3023,35984,29682,7986,39378,2642,6460,4311,35573,6459,2236,30813,39391],
+  "retainer_names":["my retainer","my other retainer","my other other retainer"],
+  "server":"Famfrit"
+}
+```
+![image](https://github.com/ff14-advanced-market-search/saddlebag-with-pockets/assets/17516896/b2496327-c429-400c-aac4-4af712a6be10)
+
+Undercut alert (use with `/ff undercut`):
+```
+{
+    "retainer_names": ["my retainer","my other retainer","my other other retainer"],
+    "server": "Lich",
+    "add_ids": [],
+    "ignore_ids": [],
+    "hq_only": false,
+    "ignore_data_after_hours": 720,
+    "ignore_undercuts_with_quantity_over": 9999
+}
+```
+

package/docs/wiki/saddlebag/api-call-guide.md

@@ -0,0 +1,173 @@
+# swagger
+
+[View the full api and definitions on our swaggerhub page](https://app.swaggerhub.com/apis/SaddlebagExchange/ffxiv/)
+
+[converted with this tool](https://kevinswiber.github.io/postman2openapi/)
+
+# curl examples
+
+Using DNS record. Note `http` must be used with http://api.saddlebagexchange.com, https doesnt work because of some cloudflare stuff
+```
+$ curl -s -X POST \
+    http://api.saddlebagexchange.com/api/seller/ \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+        "item_id": 4745,
+        "home_server": "Midgardsormr",
+        "retainer_name": "Kainin"
+    }' | jq .
+
+{
+  "seller_id": "590362b2eb930741fc65059060033d10e6415743f6e677ec822ba6b2074bf8d4"
+}
+```
+
+another to try
+
+```
+curl -s -X POST \
+    http://api.saddlebagexchange.com/api/scan/ \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+        "preferred_roi": 99, 
+        "min_profit_amount": 10000,
+        "min_desired_avg_ppu": 10000,
+        "min_stack_size": 1,
+        "hours_ago": 168,
+        "min_sales": 2,
+        "hq": false,
+        "home_server": "Yojimbo",
+        "filters": [0],
+        "region_wide": false,
+        "include_vendor": false,
+        "show_out_stock": true
+    }' | jq .
+```
+
+curl example with ip
+
+```
+$ curl -s -X POST \
+    http://1.2.3.4/api/seller/ \
+    -H 'Accept: application/json' \
+    -H 'Content-Type: application/json' \
+    -d '{
+        "item_id": 4745,
+        "home_server": "Midgardsormr",
+        "retainer_name": "Kainin"
+    }' | jq .
+
+{
+  "seller_id": "590362b2eb930741fc65059060033d10e6415743f6e677ec822ba6b2074bf8d4"
+}
+```
+
+# Postman examples
+
+You can also run this with postman instead of curl 
+
+<img width="619" alt="image" src="https://user-images.githubusercontent.com/17516896/190919261-cb541bdc-70e3-4773-b2d5-94275bac3da0.png">
+
+<img width="611" alt="image" src="https://user-images.githubusercontent.com/17516896/190919290-312a9998-1951-451d-b031-f26e87fd94d1.png">
+
+
+# POST Content
+
+## FFXIV
+
+### Scan
+
+http://api.saddlebagexchange.com/api/scan
+
+```json
+{
+    "preferred_roi": 50, 
+    "min_profit_amount": 10000,
+    "min_desired_avg_ppu": 10000,
+    "min_stack_size": 1,
+    "hours_ago": 24,
+    "min_sales": 4,
+    "hq": false,
+    "home_server": "Famfrit",
+    "filters": [0],
+    "region_wide": false,
+    "include_vendor": false,
+    "show_out_stock": true,
+    "universalis_list_uid": ""
+}
+```
+
+### History
+http://api.saddlebagexchange.com/api/history
+```json
+{
+    "item_id": 36109,
+    "home_server": "Midgardsormr",
+    "initial_days": 7,
+    "end_days": 0,
+    "item_type": "all"
+}
+```
+### Listing
+http://api.saddlebagexchange.com/api/listing
+```json
+{
+    "item_id": 36109,
+    "home_server": "Midgardsormr",
+    "initial_days": 30,
+    "end_days": 0
+}
+```
+
+### export
+
+http://api.saddlebagexchange.com/api/export
+
+api post body
+
+```json
+  {
+    "home_server": "Famfrit", 
+    "export_servers": ["Lamia","Seraph"],
+    "item_ids": [33275,4745],
+    "hq_only": false
+  }
+```
+
+### ffxiv market share
+
+http://api.saddlebagexchange.com/api/ffxivmarketshare/
+
+```json
+{
+    "server": "Famfrit",
+    "time_period": 24,
+    "sales_amount": 2,
+    "average_price": 10000,
+    "filters": [0]
+}
+```
+
+### Allagan Tools data parsing
+
+http://api.saddlebagexchange.com/api/parseallagan
+
+```json
+{
+    "server": "Famfrit",
+    "allagan_json_data": $DATA_COPIED_FROM_ALLAGAN_TOOLS
+}
+```
+### Self purchase 
+
+http://api.saddlebagexchange.com/api/selfpurchase
+
+
+```json
+{
+    "server": "Famfrit",
+    "player_name": "Aere Noctum"
+}
+```