Felo API PlatformFelo API Platform
همه endpointهای Financial Data
v0.2.0-beta
OpenAPI 3.1.0

جستجوی صورت‌های مالی

سرور:https://openapi.felo.ai
کتابخانه‌های کلاینت

Financial Data

​

Company fundamentals, financial statements, market prices and economic data.

جستجوی صورت‌های مالی

​

tickerهایی را بیابید که با شرایط عددی مطابقت دارند. بدنه filters را می‌گیرد — هر یک field، operator و value — به‌همراه limit. results را با ticker، currency، sector، industry و هر فیلد فیلترشده‌ای که مطابقت کرده برمی‌گرداند. این تنها ابزار اینجاست که بدون دانستن ticker از قبل کار می‌کند؛ بقیه یکی را به‌عنوان ورودی می‌گیرند. فیلدهای قابل فیلتر نام معیارهایی هستند که get_financial_financial_metrics برمی‌گرداند. از آن برای ساختن فهرست نامزدها استفاده کنید، سپس جزئیات هر نام را با ابزارهای صورت یا معیار بکشید.

مرجع قیمت‌گذاری

  • اندازه‌گیری: مبنای هزینه ثابت برای درخواست موفق.
  • برآورد درخواست مرجع: 0.02 دلار آمریکا.
  • ضریب مشتری مرجع: 1.0. آن را دوباره روی مبلغ تسویه‌شده مشتری اعمال نکنید.

فقط فراداده مرجع، نه نقل‌قول حساب، نه قیمت تضمین‌شده و نه سقف هزینه. اعتبار منابع، اعتبار Felo نیست. هزینه‌های نهایی تابع سوابق صورت‌حساب Felo است.

بدنه
الزامی
application/json
  • filters
    نوع: array object[] 1…
    الزامی

    آرایه‌ای از اشیای فیلتر برای اعمال روی جستجو.

    • field
      نوع: string
      الزامی

      معیارهای فیلتر. برای فیلدهای شاخص مالی از عملگرهای 'gt'، 'lt'، 'gte'، 'lte'، 'eq' استفاده کنید. برای فیلدهای 'ticker' و 'cik' از عملگر 'in' برای فیلتر در برابر چند مقدار استفاده کنید.

    • operator
      نوع: string فهرست مقادیر
      الزامی

      عملگر مقایسه. عملگر 'in' فقط با مقدار فیلد 'ticker' یا 'cik' قابل استفاده است و امکان فیلتر در برابر چند مقدار را می‌دهد.

      مقادیر
      • gt
      • lt
      • gte
      • lte
      • eq
      • in
    • value
      الزامی
      • نوع: number

        مقداری که برای عملگرهای تک‌مقداری (gt، lt، gte، lte، eq) با آن مقایسه می‌شود

  • limit
    نوع: integer
    حداقل:  
    1

    حداکثر تعداد نتایج برای برگرداندن.

پاسخ‌ها
  • 200
    نوع: object · ResponseE40Feb4D3D6B_FinancialsSearchResponse

    پاسخ جستجوی موفق

    • search_results
      نوع: array object[]
      • currency
        نوع: string

        واحد پول داده‌های مالی.

      • period
        نوع: string فهرست مقادیر

        بازه زمانی داده‌های مالی.

        مقادیر
        • annual
        • quarterly
        • ttm
      • report_period
        نوع: string قالب: date

        دوره گزارش داده‌های مالی.

      • ticker
        نوع: string

        نماد تیکر شرکت.

      • propertyName
        نوع: string

        شاخص‌های مالی تکمیلی بر اساس معیارهای جستجو.

    application/json
  • 400

    درخواست پردازش نشد. پارامترهای درخواست را بررسی کنید.

  • 401

    یک کلید API معتبر Felo لازم است.

  • 402

    درخواست ادامه نمی‌یابد چون یک الزام صورت‌حساب برآورده نشده است.

  • 403

    حساب مجاز به انجام این عملیات نیست.

  • 429

    به سقف درخواست یا هزینه رسیده‌اید.

  • 502

    سرویس نتوانست درخواست را کامل کند.

  • 503

    سرویس API یا صورت‌حساب موقتاً در دسترس نیست.

  • 504

    سرویس هنگام پردازش درخواست به پایان مهلت رسید.

  • default

    پاسخ خطا؛ پاسخ‌های عبوری بالادست ممکن است از قالب‌های ارائه‌دهنده استفاده کنند

    application/json
Request Example for post/v1/beta/financial/financials/search/screener
curl https://openapi.felo.ai/v1/beta/financial/financials/search/screener \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "limit": 10,
  "filters": [
    {
      "field": "",
      "operator": "gt",
      "value": 1
    }
  ]
}'
{
  "search_results": [
    {
      "ticker": "string",
      "report_period": "2026-10-26",
      "period": "annual",
      "currency": "string",
      "additionalProperty": "string"
    }
  ]
}
Search financial statements