{ "openapi": "3.0.1", "info": { "title": "FHLBank Membership Roster & Delta Monitor", "description": "FHLBank System membership roster and quarter-over-quarter delta tracker sourced from FHFA's published member file: joins, exits and attribute changes across all 11 districts, with CERT/FED_ID/NCUA_ID/NAIC_ID join keys for correspondent banking, KYB and competitive intel.", "version": "1.0", "x-build-id": "AlJc5NBmcrNysKS4q" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/malonestar~fhlbank-membership-delta-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-malonestar-fhlbank-membership-delta-monitor", "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/malonestar~fhlbank-membership-delta-monitor/runs": { "post": { "operationId": "runs-sync-malonestar-fhlbank-membership-delta-monitor", "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/malonestar~fhlbank-membership-delta-monitor/run-sync": { "post": { "operationId": "run-sync-malonestar-fhlbank-membership-delta-monitor", "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": { "mode": { "title": "Mode", "enum": [ "roster", "delta" ], "type": "string", "description": "\"roster\" returns a filtered listing of current FHLBank members. \"delta\" resolves the prior quarter's file too and returns only join/exit/attribute_change events between it and the current quarter.", "default": "roster" }, "states": { "title": "States", "type": "array", "description": "Optional list of US states/territories to filter by (2-letter postal code, e.g. \"CO\", or the full name, e.g. \"Colorado\" -- both are recognized). Leave empty for all states.", "default": [], "items": { "type": "string" } }, "charterTypes": { "title": "Charter types", "type": "array", "description": "Optional list of charter types to filter by: \"Federal\", \"National\", \"State\", or \"None\". Leave empty for all charter types.", "default": [], "items": { "type": "string" } }, "districts": { "title": "FHLBank districts", "type": "array", "description": "Optional list of FHLBank districts to filter by (Atlanta, Boston, Chicago, Cincinnati, Dallas, Des Moines, Indianapolis, New York, Pittsburgh, San Francisco, Topeka). Leave empty for all districts.", "default": [], "items": { "type": "string" } }, "memberSince": { "title": "Member since (on or after)", "pattern": "^$|^\\d{4}-\\d{1,2}-\\d{1,2}$", "type": "string", "description": "Optional cutoff. Only include members whose FHFA-published membership date is on or after this date. MUST be YYYY-MM-DD (e.g. 2020-01-15) - any other format is rejected and the run FAILS without billing, rather than silently returning every member or none of them. It is string-compared against ISO membership dates: an unvalidated '01/15/2020' returned the WHOLE matching set (as if no cutoff were applied) and 'Jan 2020' returned ZERO rows, both labelled a successful filtered answer. Slash forms are rejected on purpose - 05/06/2025 is ambiguous between US and EU order. Leave blank for no cutoff." }, "quarter": { "title": "Quarter override", "type": "string", "description": "Optional exact quarter to use as the \"current\" file, in the form q<1-4>, e.g. \"q22026\" for the April-June 2026 file. Leave blank to automatically use the most recently posted quarter (with rollback up to 4 quarters if it is not yet posted)." }, "eventTypes": { "title": "Delta event types", "type": "array", "description": "Delta mode only. Which event types to include: \"join\" (new members), \"exit\" (members no longer in the current file), \"attribute_change\" (a field changed for an existing member). Leave empty to include all three.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of rows (roster mode) or delta events (delta mode) to return in this run.", "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 } } }, "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 } } } } } } } } } }