Skip to main content

Get Balance Report In Graphql

This query returns a balance report for selected portfolios on a given date.

Screenshot 2025-12-16 at 18.12.20.png


GraphQL Query

query GetBalanceReport {
  balance_report(
    input: {
      report_date: "2024-05-01"
      report_currency: "USD"
      pricing_policy: "com.finmars.standard-pricing:standard"
      portfolios: ["Commodity Portfolio"]
    }
  ) {
    items {
      id
      item_type
      item_type_name
      name
      market_value
      position_size
    }
  }
}

Input Highlights

Report Date

report_date: "2024-05-01"
  • Snapshot date
  • ISO date format
  • Required field

Report Currency

report_currency: "USD"
  • Output currency
  • Must exist in the system

Pricing Policy

pricing_policy: "com.finmars.standard-pricing:standard"
  • Defines valuation rules
  • Uses pricing engine configuration
  • Required for valuation

Portfolios

portfolios: ["Commodity Portfolio"]
  • List of portfolio user codes
  • Supports multiple portfolios

Python Code

import requests

url = "https://<domain_name>/<realm_code>/<space_code>/graphql/"

headers = {
    "Authorization": "Bearer <access_token>",
    "Content-Type": "application/json"
}

payload = {
    "query": """
    query GetBalanceReport {
      balance_report(
        input: {
          report_date: "2024-05-01"
          report_currency: "USD"
          pricing_policy: "com.finmars.standard-pricing:standard"
          portfolios: ["Commodity Portfolio"]
        }
      ) {
        items {
          id
          item_type
          item_type_name
          name
          market_value
          position_size
        }
      }
    }
    """
}

response = requests.post(url, json=payload, headers=headers)
print(response.json())



Notes

  • This is not a list query.
  • No pagination.
  • Uses input instead of filters.
  • Report queries execute calculations.