> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ngnmarket.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Agent Quickstart

> Paste one prompt into your coding agent to find where NGX market data would replace hardcoded values, scrapers, or manual calculations in your codebase.

export const agentPrompt = `Install and use the NGN Market API skill, then audit this repository for places
where it should replace what's currently there. Follow these steps in order:

1. Confirm an NGNMARKET_API_KEY environment variable is set. If it isn't, stop
   and tell me to get one from https://ngnmarket.com/developer before continuing.

2. Install the skill file by following https://docs.ngnmarket.com/install-skill
   (prefer \`npx skills add -g https://docs.ngnmarket.com/skill.md\` if the
   \`skills\` CLI is available; otherwise use the manual curl install for
   whichever agent you are).

3. Scan this repository for NGX/Nigerian-market data patterns that the API
   could replace. Look specifically for:
   - Hardcoded stock prices or static price objects (e.g. sample NGX tickers
     with fixed prices in fixtures, seed data, or demo components)
   - Static JSON shaped like OHLCV history (arrays/objects with open, high,
     low, close, volume, or timestamp + price fields for a stock symbol)
   - Manually maintained lists of NGX companies, sectors, or tickers
   - Homegrown NGN/USD (or other currency) conversion math, or a hardcoded
     exchange rate constant
   - Manually typed or manually updated dividend dates/calendars
   - Scraped or manually sourced company logos for NGX-listed tickers
   - Custom sorting/filtering logic that recomputes "top gainers" or
     "top losers" from raw price data
   - Hand-parsed NGX news, press releases, or corporate disclosure text

4. For each match, report: the file and line number, what it's currently
   doing, which NGN Market API endpoint would replace it (from the skill's
   recipe table), which plan tier that endpoint requires, and a one-line
   reason it's a better approach (freshness, correctness, maintenance cost).
   Present this list and WAIT for my approval — do not edit any files yet.

5. Once I approve (whether that's "do all of them", specific items, or none),
   make only the approved changes. If nothing in this repo matches, or after
   you're done, suggest 3-5 concrete integrations and 2-3 side-project ideas
   that would make sense given this codebase's actual stack and purpose.
`;

This page gives your coding agent (Claude Code, Cursor, or similar) a single prompt that installs the NGN Market skill, scans your repository for integration opportunities, and proposes changes without editing anything until you approve.

<Steps>
  <Step title="Sign up">
    Create a free account at [ngnmarket.com](https://ngnmarket.com) and verify your email. You can use the free plan for basic integrations, but most endpoints require a paid plan.
  </Step>

  <Step title="Copy your key from the dashboard">
    After signing in, go to your [developer dashboard](https://ngnmarket.com/developer) and copy your API key. It looks like `ngm_live_XXXXXXXXXXXXXXXXXXXX`.

    <Frame caption="Your API key on the developer dashboard">
      <img src="https://mintcdn.com/ngnmarket/H9hhIJmqpOLMKuW1/images/ngn-market-dev-api-key.jpg?fit=max&auto=format&n=H9hhIJmqpOLMKuW1&q=85&s=fef4e59d0acd636516703efa500563d8" width="3024" height="1370" data-path="images/ngn-market-dev-api-key.jpg" />
    </Frame>
  </Step>

  <Step title="Expose it as an environment variable">
    Store your API key in an environment variable called `NGNMARKET_API_KEY`. For example, on macOS or Linux:

    ```bash theme={null}
    export NGNMARKET_API_KEY="ngm_live_XXXXXXXXXXXXXXXXXXXX"
    ```

    On Windows (PowerShell):

    ```powershell theme={null}
    $env:NGNMARKET_API_KEY="ngm_live_XXXXXXXXXXXXXXXXXXXX"
    ```
  </Step>

  <Step title="Paste this prompt into your agent">
    Run your agent in the repo you want scanned, then paste this in.

    <div className="prompt-card">
      <p className="prompt-card-subtitle">Paste this into your agent's chat, in the repo you want scanned.</p>

      <div className="prompt-card-scroll">
        ```text theme={null}
        Install and use the NGN Market API skill, then audit this repository for places
        where it should replace what's currently there. Follow these steps in order:

        1. Confirm an NGNMARKET_API_KEY environment variable is set. If it isn't, stop
           and tell me to get one from https://ngnmarket.com/developer before continuing.

        2. Install the skill file by following https://docs.ngnmarket.com/install-skill
           (prefer `npx skills add -g https://docs.ngnmarket.com/skill.md` if the
           `skills` CLI is available; otherwise use the manual curl install for
           whichever agent you are).

        3. Scan this repository for NGX/Nigerian-market data patterns that the API
           could replace. Look specifically for:
           - Hardcoded stock prices or static price objects (e.g. sample NGX tickers
             with fixed prices in fixtures, seed data, or demo components)
           - Static JSON shaped like OHLCV history (arrays/objects with open, high,
             low, close, volume, or timestamp + price fields for a stock symbol)
           - Manually maintained lists of NGX companies, sectors, or tickers
           - Homegrown NGN/USD (or other currency) conversion math, or a hardcoded
             exchange rate constant
           - Manually typed or manually updated dividend dates/calendars
           - Scraped or manually sourced company logos for NGX-listed tickers
           - Custom sorting/filtering logic that recomputes "top gainers" or
             "top losers" from raw price data
           - Hand-parsed NGX news, press releases, or corporate disclosure text

        4. For each match, report: the file and line number, what it's currently
           doing, which NGN Market API endpoint would replace it (from the skill's
           recipe table), which plan tier that endpoint requires, and a one-line
           reason it's a better approach (freshness, correctness, maintenance cost).
           Present this list and WAIT for my approval — do not edit any files yet.

        5. Once I approve (whether that's "do all of them", specific items, or none),
           make only the approved changes. If nothing in this repo matches, or after
           you're done, suggest 3-5 concrete integrations and 2-3 side-project ideas
           that would make sense given this codebase's actual stack and purpose.
        ```
      </div>

      <div className="prompt-card-actions">
        <button
          className="prompt-copy-btn"
          onClick={(e) => {
        navigator.clipboard.writeText(agentPrompt);
        const btn = e.currentTarget;
        const label = btn.querySelector('span');
        const original = label.textContent;
        btn.classList.add('copied');
        label.textContent = 'Copied!';
        setTimeout(() => {
          btn.classList.remove('copied');
          label.textContent = original;
        }, 2000);
      }}
        >
          <svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
            <rect x="9" y="9" width="13" height="13" rx="2" ry="2" />

            <path d="M5 15H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2h9a2 2 0 0 1 2 2v1" />
          </svg>

          <span>Copy prompt</span>
        </button>
      </div>
    </div>
  </Step>

  <Step title="Review before it edits anything">
    The prompt is written to stop and show you its findings first. Expect a list like:

    ```
    src/data/demo-prices.json:1-40 — hardcoded prices for 12 NGX tickers
      → replace with GET /companies (free plan)
      → reason: demo data goes stale; live endpoint always current

    src/lib/convertNaira.js:8 — hardcoded USD/NGN rate (1500)
      → replace with GET /forex/current (free plan)
      → reason: fixed rate drifts from the real exchange rate daily
    ```

    Approve what you want, skip the rest. Your agent should not touch anything you didn't sign off on.
  </Step>
</Steps>

<Note>
  This scans for **patterns**, not exact matches. Review every suggestion before approving. The agent has no special access to your code beyond what it can already read; nothing is uploaded or shared with NGN Market.
</Note>

<CardGroup cols={2}>
  <Card title="Install the skill" icon="puzzle-piece" href="/install-skill">
    Manual install paths per agent, if you'd rather skip the CLI
  </Card>

  <Card title="Guides" icon="book-open" href="/guides/live-price-ticker">
    Full worked examples for the most common integrations
  </Card>
</CardGroup>