PAMM Iran Data API

Data principles

• Published data only: no personal data, drafts or rejected accounts are ever served.
• The account page’s display rule: a figure the page would not show has no value in the API either.
• Every figure with its state: “declared” data always carries that label and must not be shown as live data.
• Neutral order: lists are alphabetical and the API offers no ranking or advice; sponsorship is only disclosed.
• Every response carries its production time, source and licence link.

Getting started

1. Sign in to PAMM Iran and request access under “Data API” with your business name and use case.
2. Once approved, create a key and set its scopes, allowed IPs and expiry. The key is shown only once.
3. Start on the free tier; for more quota and scopes, buy a suitable plan from the same page.

Authentication

Send the key in the Authorization header as a Bearer token (or in the X-Api-Key header). Never put the key in browser-side code or a public repository; call the API from your own server.

curl -H "Authorization: Bearer pamm_XXXXXXXXXXXX.YYYYYYYY…" \
     "https://pamm.ir/api/v1/accounts?locale=en"

Endpoints

https://pamm.ir/api/v1

The locale parameter (fa or en) selects the language of text fields. Names and slugs in both languages are always included.

Response format

Every successful response has a data object and a meta object. Metrics carry their value, unit, state, label and computation time.

{
  "data": {
    "id": "…",
    "name": "…",
    "metrics": {
      "cumulative-return": {
        "value": "…", "unit": "…",
        "state": "declared", "label": "Declared",
        "computed_at": "…", "declared_at": "…"
      },
      "max-drawdown": { "value": null, "state": "unavailable", "label": null }
    }
  },
  "meta": {
    "source": "PAMM Iran — pamm.ir",
    "as_of": "…",
    "locale": "en",
    "licence": "https://pamm.ir/legal/data_api_terms"
  }
}

• live — Live data from a connected, fresh source.
• declared — Declared data; its label must be shown next to the figure.
• unavailable — Not published, not fresh or not displayable; the value is empty and must not be filled with another number.
• stale — In rate tables: an automatic source has gone stale and no price is served from it.

Limits and headers

Each client has a per-minute limit and a monthly quota applied across all its keys. The limit status is returned in the headers of every response.

• X-RateLimit-Limit — Requests allowed per minute
• X-RateLimit-Remaining — Requests left in the current minute
• X-Quota-Limit — Monthly quota
• X-Quota-Remaining — Quota left this month
• X-Quota-Reset — Start of the next period (UTC)
• Retry-After — Seconds until you may retry, on a 429 response

Errors

Tiers and plans

Prices are in Tether (USDT). Pay from your PAMM Iran wallet or a verified USDT wallet in your own name; clients inside Iran can also pay the rial equivalent from their own verified card or IBAN. Contact support for an enterprise agreement.

Data widgets

If you would rather not write code, widgets are the simplest way to show PAMM Iran data on your site: one line of code, no scripts, always up to date.

• The free version of every widget (accounts, baskets, audits, broker, exchange and prop firm comparisons, pools, USDT rates and gold prices) is open to everyone, with the “Powered by PAMM Iran” line.
• Plans that include widgets give you a dedicated key: the widget opens only on your domain and shows without the brand line while the plan is active.
• Account managers with official verification take their verified performance card from their own panel and put it on their site.
• Widgets follow the same rules as the public pages: each figure keeps its status label, and accounts are listed alphabetically, never as a ranking.

Full guide to widgets