{
  "name": "PyBLP product_data fields and when each is needed",
  "description": "Compiled from the pyblp.Problem API reference and the PyBLP random coefficients tutorial: for each product_data field named in the reference, whether it is required, optional or conditional, and what the documentation says it is used for.",
  "page": "https://casrai.org/guides/pyblp",
  "publisher": "CASRAI",
  "license": "https://creativecommons.org/licenses/by/4.0/",
  "dateModified": "2026-11-19T20:06:43Z",
  "temporalCoverage": "2026",
  "spatialCoverage": null,
  "columns": [
    {
      "name": "Field",
      "unit": "",
      "description": ""
    },
    {
      "name": "Requirement",
      "unit": "",
      "description": ""
    },
    {
      "name": "Documented role",
      "unit": "",
      "description": ""
    }
  ],
  "rows": [
    {
      "Field": "market_ids",
      "Requirement": "Required",
      "Documented role": "Identifies the market each product row belongs to"
    },
    {
      "Field": "shares",
      "Requirement": "Required",
      "Documented role": "Observed market shares of the inside products"
    },
    {
      "Field": "prices",
      "Requirement": "Required",
      "Documented role": "Product prices"
    },
    {
      "Field": "firm_ids",
      "Requirement": "Required if a supply side (X3) is specified",
      "Documented role": "Identifies the firm that sells each product"
    },
    {
      "Field": "demand_instruments0, demand_instruments1, ...",
      "Requirement": "Excluded instruments (supplied as numbered columns)",
      "Documented role": "Demand-side excluded instruments"
    },
    {
      "Field": "supply_instruments0, supply_instruments1, ...",
      "Requirement": "Excluded instruments (supplied as numbered columns)",
      "Documented role": "Supply-side excluded instruments"
    },
    {
      "Field": "nesting_ids",
      "Requirement": "Optional; rho is then required in solve",
      "Documented role": "Defines nests for nested logit and RCNL models"
    },
    {
      "Field": "clustering_ids",
      "Requirement": "Optional",
      "Documented role": "Used for clustered weighting and standard errors (W_type and se_type set to clustered in the tutorial)"
    },
    {
      "Field": "ownership",
      "Requirement": "Optional",
      "Documented role": "Listed as an optional product_data field in the API reference"
    },
    {
      "Field": "product_ids",
      "Requirement": "Optional",
      "Documented role": "Listed as an optional product_data field in the API reference"
    }
  ],
  "sources": [
    {
      "title": "PyBLP documentation: pyblp.Problem",
      "url": "https://pyblp.readthedocs.io/en/stable/_api/pyblp.Problem.html",
      "accessed": "2026-11-19"
    },
    {
      "title": "PyBLP documentation: Random coefficients tutorial (automobile data)",
      "url": "https://pyblp.readthedocs.io/en/stable/_notebooks/tutorial/blp.html",
      "accessed": "2026-11-19"
    }
  ]
}