برای کسب‌وکارها و توسعه‌دهندگان

API دادهٔ پم ایران

همان دادهٔ منتشرشده در صفحات عمومی پم ایران — حساب‌های معاملاتی، شاخص‌های عملکرد، سبدهای هوشمند، ممیزی‌ها، شرکای بازار و نرخ‌ها — به‌صورت JSON و با کلید اختصاصی.

درخواست دسترسی شرایط استفاده و مجوز

اصول داده

فقط دادهٔ منتشرشده: هیچ دادهٔ شخصی، پیش‌نویس یا حساب ردشده‌ای از API عرضه نمی‌شود.
همان قاعدهٔ نمایش صفحهٔ حساب: عددی که در صفحه نمایش داده نمی‌شود، در API هم مقدار ندارد.
هر عدد با وضعیتش: دادهٔ «اعلامی» همیشه با همین برچسب می‌آید و نباید به‌عنوان دادهٔ زنده نمایش داده شود.
ترتیب خنثی: فهرست‌ها الفبایی‌اند و API هیچ رتبه‌بندی یا توصیه‌ای ارائه نمی‌کند؛ حمایت مالی فقط افشا می‌شود.
هر پاسخ زمان تولید، منبع و لینک مجوز را همراه دارد.

شروع کار

وارد حساب پم ایران شوید و از «API داده» درخواست دسترسی با نام کسب‌وکار و کاربرد ثبت کنید.
پس از تأیید، کلید بسازید و دامنهٔ دسترسی، IPهای مجاز و انقضای آن را تعیین کنید. کلید فقط یک بار نمایش داده می‌شود.
در سطح رایگان شروع کنید؛ برای سهمیه و دامنهٔ بیشتر، پلن مناسب را از همان صفحه خریداری کنید.

احراز هویت

کلید را در سرآیند Authorization به شکل Bearer بفرستید (یا در سرآیند X-Api-Key). کلید را هرگز در کد سمت مرورگر یا مخزن عمومی قرار ندهید؛ درخواست‌ها را از سرور خود بفرستید.

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

نقاط دسترسی

https://pamm.ir/api/v1

متد	مسیر	دامنهٔ دسترسی	شرح
`GET`	`/me`	—	اطلاعات کلید، سطح دسترسی، سقف‌ها و مصرف این ماه (از سهمیه کم نمی‌شود).
`GET`	`/accounts?type=`	حساب‌های معاملاتی و شاخص‌ها	فهرست حساب‌های معاملاتی منتشرشده؛ فیلتر اختیاری نوع حساب.
`GET`	`/accounts/{id}`	حساب‌های معاملاتی و شاخص‌ها	گزارش عملکرد یک حساب با شرایط، افشا و همهٔ شاخص‌های عملکرد با وضعیت هر کدام.
`GET`	`/baskets?risk=`	سبدهای هوشمند	سبدهای هوشمند منتشرشده با ترکیب وزنی و خلاصهٔ عملکرد فرضی؛ فیلتر ریسک.
`GET`	`/baskets/{slug}`	سبدهای هوشمند	یک سبد با ترکیب کامل و بازدهٔ ماهانهٔ فرضی.
`GET`	`/audits?result=`	ممیزی‌ها	نتیجهٔ ممیزی‌های منتشرشده و ابطال‌شده؛ فیلتر نتیجه.
`GET`	`/audits/{reference}`	ممیزی‌ها	یک ممیزی با دورهٔ بررسی، خلاصه و اعتبار.
`GET`	`/partners?category=`	شرکای بازار	صرافی‌ها، بروکرها، پراپ‌ها و استخرهای منتشرشده با مشخصات ثبت‌شده و منبع آن؛ فیلتر دسته.
`GET`	`/markets/tether`	نرخ تتر و طلا	جدول نرخ تتر به ریال از منابع فعال، با وضعیت تازگی هر منبع.
`GET`	`/markets/gold`	نرخ تتر و طلا	جدول طلا و سکه با ارزش ذاتی و حباب، هر جا اونس و دلار تازه باشند.

پارامتر locale با مقدار fa یا en زبان متن‌ها را تعیین می‌کند. نام و slug هر دو زبان همیشه در پاسخ هست.

قالب پاسخ

هر پاسخ موفق یک شیء data و یک شیء meta دارد. شاخص‌ها مقدار، واحد، وضعیت، برچسب و زمان محاسبه را همراه دارند.

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

live — دادهٔ زنده از منبع متصل و تازه.
declared — دادهٔ اعلامی؛ برچسب آن باید کنار عدد نمایش داده شود.
unavailable — منتشر، تازه یا قابل‌نمایش نیست؛ مقدار خالی است و نباید با عدد دیگری پر شود.
stale — در جدول نرخ‌ها: منبع خودکار قدیمی شده و قیمتی از آن ارائه نمی‌شود.

سقف‌ها و سرآیندها

هر مشتری یک سقف درخواست در دقیقه و یک سهمیهٔ ماهانه دارد که روی مجموع کلیدهایش اعمال می‌شود. وضعیت سقف‌ها در سرآیند هر پاسخ می‌آید.

X-RateLimit-Limit — سقف درخواست در دقیقه
X-RateLimit-Remaining — درخواست باقی‌مانده در دقیقهٔ جاری
X-Quota-Limit — سهمیهٔ ماهانه
X-Quota-Remaining — سهمیهٔ باقی‌مانده در این ماه
X-Quota-Reset — زمان آغاز دورهٔ بعد (UTC)
Retry-After — ثانیه تا امکان درخواست دوباره، در پاسخ ۴۲۹

خطاها

HTTP	کد	شرح
401	`invalid_key`	کلید نیست، نامعتبر، باطل یا منقضی است.
403	`client_suspended`	دسترسی مشتری معلق است.
403	`ip_not_allowed`	درخواست از IP خارج از فهرست مجاز کلید آمده است.
403	`scope_not_granted_to_key`	این داده در دامنهٔ کلید نیست.
403	`scope_not_in_plan`	این داده در سطح یا پلن فعلی شما باز نیست.
404	`not_found`	مورد درخواستی منتشر نشده یا وجود ندارد.
429	`rate_limited`	سقف دقیقه‌ای پر شده است؛ پس از Retry-After دوباره بفرستید.
429	`monthly_quota_exhausted`	سهمیهٔ ماهانه تمام شده است؛ پلن را ارتقا دهید یا تا دورهٔ بعد صبر کنید.

سطح‌ها و پلن‌ها

سطح رایگان

سقف درخواست در دقیقه: 10
سهمیهٔ ماهانه (درخواست): 3,000
دامنهٔ دسترسی: ممیزی‌ها، شرکای بازار، نرخ تتر و طلا

قیمت‌ها به تتر (USDT) است. از کیف پول پم ایران یا کیف پول تترِ تأییدشدهٔ به نام خودتان بپردازید؛ مشتریان داخل ایران می‌توانند معادل ریالی را از کارت یا شبای تأییدشدهٔ خودشان واریز کنند. برای قرارداد سازمانی با پشتیبانی تماس بگیرید.

ابزارک‌های داده

اگر نمی‌خواهید کد بنویسید، ابزارک‌ها ساده‌ترین راه نمایش دادهٔ پم ایران در سایت شما هستند: یک خط کد، بدون اسکریپت و همیشه به‌روز.

نسخهٔ رایگان همهٔ ابزارک‌ها (حساب‌ها، سبدها، ممیزی‌ها، مقایسهٔ بروکر و صرافی و پراپ‌فرم، استخرها، نرخ تتر و قیمت طلا) با نشان «قدرت گرفته از پم ایران» برای همه باز است.
پلن‌هایی که ابزارک دارند، کلید اختصاصی می‌دهند: ابزارک فقط روی دامنهٔ شما باز می‌شود و تا وقتی پلن فعال است، بدون نشان نمایش داده می‌شود.
مدیران حسابی که تأیید رسمی دارند، کارت عملکرد تأییدشدهٔ حسابشان را از پنل خودشان برمی‌دارند و در سایت خود می‌گذارند.
ابزارک‌ها همان قواعد صفحه‌های عمومی را دارند: برچسب وضعیت هر عدد حفظ می‌شود و حساب‌ها به ترتیب الفبا نمایش داده می‌شوند، نه رتبه.

ابزارک	کد رایگان
حساب‌های معاملاتی	حساب‌های معاملاتی
سبدهای هوشمند	سبدهای هوشمند
ممیزی حساب‌ها	ممیزی حساب‌ها
مقایسهٔ بروکرها	مقایسهٔ بروکرها
مقایسهٔ صرافی‌ها	مقایسهٔ صرافی‌ها
مقایسهٔ پراپ‌فرم‌ها	مقایسهٔ پراپ‌فرم‌ها
استخرهای فیوچرز	استخرهای فیوچرز
نرخ تتر	نرخ تتر
قیمت طلا و سکه	قیمت طلا و سکه
نرخ تتر و طلا	نرخ تتر و طلا

راهنمای کامل ابزارک‌ها