{
  "openapi": "3.0.1",
  "info": {
    "title": "Fed Z.1 Financial Accounts API — Flow of Funds Data",
    "description": "Federal Reserve Z.1 Financial Accounts (flow of funds) as data: household net worth, debt, assets and liabilities by sector and instrument, quarterly and annual, from 1945. Filter by series, sector, instrument and date. No API key. Part of NexGen Signal — official-source data products",
    "version": "0.1",
    "x-build-id": "g32CY9tzpq0uQg8g8"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nexgensignal~fed-z1-financial-accounts-flow-of-funds-observations/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nexgensignal-fed-z1-financial-accounts-flow-of-funds-observations",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/nexgensignal~fed-z1-financial-accounts-flow-of-funds-observations/runs": {
      "post": {
        "operationId": "runs-sync-nexgensignal-fed-z1-financial-accounts-flow-of-funds-observations",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/nexgensignal~fed-z1-financial-accounts-flow-of-funds-observations/run-sync": {
      "post": {
        "operationId": "run-sync-nexgensignal-fed-z1-financial-accounts-flow-of-funds-observations",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "seriesNames": {
            "title": "Series codes",
            "type": "array",
            "description": "Exact Board series codes, e.g. FL152090005.Q (households and nonprofits; net worth; quarterly).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "seriesNameStartsWith": {
            "title": "Series codes starting with",
            "type": "array",
            "description": "Series whose code starts with any of these, e.g. FL15.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "descriptionContains": {
            "title": "Description contains",
            "type": "array",
            "description": "Series whose description has every word of an entry, any order; put a phrase in double quotes to keep it together, e.g. households \"net worth\".",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "prefixCodes": {
            "title": "Series prefix codes",
            "type": "array",
            "description": "Two-letter Z.1 prefix: FL level (NSA), FA transactions (SAAR), FU transactions (NSA), FR revaluations, LM market-value level, etc.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "sectorCodes": {
            "title": "Sector codes",
            "type": "array",
            "description": "Two-digit Z.1 sector codes, e.g. 15 households and nonprofit organizations, 10 nonfinancial corporate business, 31 federal government, 70 private depository institutions.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "instrumentCodes": {
            "title": "Instrument codes",
            "type": "array",
            "description": "Five-digit Z.1 instrument codes, e.g. 20900 net worth, 41900 total liabilities, 30641 corporate equities (asset), 31651 one-to-four family mortgages (liability).",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "frequencies": {
            "title": "Frequencies",
            "type": "array",
            "description": "Any of quarterly, annual. Empty = all.",
            "default": [],
            "items": {
              "type": "string"
            }
          },
          "dateFrom": {
            "title": "Date from",
            "type": "string",
            "description": "Only observations on or after this date (2024-01-01, or a year such as 2024)."
          },
          "dateTo": {
            "title": "Date to",
            "type": "string",
            "description": "Only observations on or before this date (2025-12-31, or a year)."
          },
          "latestOnly": {
            "title": "Latest observation only",
            "type": "boolean",
            "description": "One record per series: its most recent observation in the date window.",
            "default": false
          },
          "includeNoData": {
            "title": "Include no-data values",
            "type": "boolean",
            "description": "Also deliver observations the Board marks no data or not calculable, with a null value.",
            "default": false
          },
          "order": {
            "title": "Order",
            "enum": [
              "newest_first",
              "oldest_first"
            ],
            "type": "string",
            "description": "Observation order within each series.",
            "default": "newest_first"
          },
          "maxRecords": {
            "title": "Maximum records",
            "minimum": 1,
            "maximum": 1000000,
            "type": "integer",
            "description": "Most observations delivered and billed in this run. One record = one value on one date.",
            "default": 1000
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}