# Aave Scraper (`felt/aave-scraper`) Actor Actor that scrapes Aave V3 market, reserve, and APY history data from the Aave. - **URL**: https://apify.com/felt/aave-scraper.md - **Developed by:** [FELT Labs](https://apify.com/felt) (community) - **Categories:** Integrations, Automation - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, NaN bookmarks - **User rating**: No ratings yet ## Pricing from $0.20 / 1,000 results This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Aave Scraper Apify Actor for collecting Aave V3 market and reserve data plus per-reserve APY history from the Aave API. ### What it can scrape - Market snapshots with chain identity, market address, total market size, and available liquidity. - Reserve snapshots with token metadata, supply data, borrow data when available, caps, utilization, flags, and incentives. - Per-reserve supply and borrow APY history for a selected lookback window. ### Example input ```json { "chainIds": [1, 8453], "underlyingTokenAddresses": ["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"], "reserveType": "BOTH", "reserveOrderBy": "tokenName", "orderDirection": "ASC", "includeApyHistory": true, "includeSupplyApyHistory": true, "includeBorrowApyHistory": true, "historyWindow": "LAST_MONTH", "maxApyHistoryReserves": 100 } ```` ### Notes - `marketAddresses` can narrow the run to specific Aave markets. - `underlyingTokenAddresses` can narrow reserve and APY history records to specific assets. - `maxApyHistoryReserves` limits the number of per-reserve history requests after market data is read. - Run `npm run start:dev` locally after creating `.env` if you need environment overrides. # Actor input Schema ## `chainIds` (type: `array`): Aave chain IDs to include. ## `marketAddresses` (type: `array`): Optional list of market addresses to include. ## `underlyingTokenAddresses` (type: `array`): Optional list of reserve underlying token addresses to include. ## `reserveType` (type: `string`): Reserve availability type to include. ## `reserveOrderBy` (type: `string`): Reserve field used for sorting. ## `orderDirection` (type: `string`): Sort direction for reserve data. ## `includeApyHistory` (type: `boolean`): Fetch reserve APY history after reading market and reserve data. ## `includeSupplyApyHistory` (type: `boolean`): Fetch supply APY history for each selected reserve. ## `includeBorrowApyHistory` (type: `boolean`): Fetch borrow APY history for each selected reserve when borrowing data is available. ## `historyWindow` (type: `string`): Lookback window for APY history. ## `maxApyHistoryReserves` (type: `integer`): Maximum number of reserve APY history records to fetch. ## Actor input object example ```json { "chainIds": [ "1" ], "marketAddresses": [], "underlyingTokenAddresses": [], "reserveType": "BOTH", "reserveOrderBy": "tokenName", "orderDirection": "ASC", "includeApyHistory": true, "includeSupplyApyHistory": true, "includeBorrowApyHistory": true, "historyWindow": "LAST_MONTH", "maxApyHistoryReserves": 1000 } ``` # Actor output Schema ## `overview` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("felt/aave-scraper").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("felt/aave-scraper").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call felt/aave-scraper --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=felt/aave-scraper", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Aave Scraper", "description": "Actor that scrapes Aave V3 market, reserve, and APY history data from the Aave.", "version": "0.1", "x-build-id": "WFEaBlqDtH1tO42jb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/felt~aave-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-felt-aave-scraper", "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/felt~aave-scraper/runs": { "post": { "operationId": "runs-sync-felt-aave-scraper", "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/felt~aave-scraper/run-sync": { "post": { "operationId": "run-sync-felt-aave-scraper", "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": { "chainIds": { "title": "Chain IDs", "uniqueItems": true, "type": "array", "description": "Aave chain IDs to include.", "items": { "type": "string", "enum": [ "1", "42161", "43114", "8453", "84532", "56", "42220", "100", "59144", "1088", "10", "137", "534352", "1868", "146", "324", "9745", "57073", "5000", "4326", "196" ], "enumTitles": [ "Ethereum (1)", "Arbitrum (42161)", "Avalanche (43114)", "Base (8453)", "Base Sepolia (84532)", "BSC (56)", "Celo (42220)", "Gnosis (100)", "Linea (59144)", "Metis (1088)", "Optimism (10)", "Polygon (137)", "Scroll (534352)", "Soneium (1868)", "Sonic (146)", "zkSync (324)", "Plasma (9745)", "Ink (57073)", "Mantle (5000)", "MegaETH (4326)", "X Layer (196)" ] }, "default": [ "1" ] }, "marketAddresses": { "title": "Market Addresses", "type": "array", "description": "Optional list of market addresses to include.", "items": { "type": "string" }, "default": [] }, "underlyingTokenAddresses": { "title": "Underlying Token Addresses", "type": "array", "description": "Optional list of reserve underlying token addresses to include.", "items": { "type": "string" }, "default": [] }, "reserveType": { "title": "Reserve Type", "enum": [ "SUPPLY", "BORROW", "BOTH" ], "type": "string", "description": "Reserve availability type to include.", "default": "BOTH" }, "reserveOrderBy": { "title": "Reserve Order By", "enum": [ "tokenName", "supplyApy", "borrowApy" ], "type": "string", "description": "Reserve field used for sorting.", "default": "tokenName" }, "orderDirection": { "title": "Order Direction", "enum": [ "ASC", "DESC" ], "type": "string", "description": "Sort direction for reserve data.", "default": "ASC" }, "includeApyHistory": { "title": "Include APY History", "type": "boolean", "description": "Fetch reserve APY history after reading market and reserve data.", "default": true }, "includeSupplyApyHistory": { "title": "Include Supply APY History", "type": "boolean", "description": "Fetch supply APY history for each selected reserve.", "default": true }, "includeBorrowApyHistory": { "title": "Include Borrow APY History", "type": "boolean", "description": "Fetch borrow APY history for each selected reserve when borrowing data is available.", "default": true }, "historyWindow": { "title": "History Window", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_MONTH", "LAST_SIX_MONTHS", "LAST_YEAR" ], "type": "string", "description": "Lookback window for APY history.", "default": "LAST_MONTH" }, "maxApyHistoryReserves": { "title": "Max APY History Reserves", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum number of reserve APY history records to fetch.", "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 } } } } } } } } } } ```