Box

Adds one or more users as followers to a project, automatically making them members if they are not already. Followers receive 'tasks added' notifications for the project.

Adds one or more users as members of the specified project. Note that added members may also become followers depending on their personal notification settings.

Adds a new URL request to a specified request queue for processing. If a request with the same uniqueKey already exists in the queue, returns the ID of the existing request instead of creating a duplicate.

Analyzes price data using the Hilbert Transform to identify whether the market is in a trend or cycle mode, returning mode values for the specified equity and time interval.

Calculate advanced analytics metrics (mean, variance, correlation, etc.) for one or more stock symbols over sliding time windows, enabling trend analysis and statistical insights across different time intervals.

Perform batch SEO analysis on multiple targets to retrieve comprehensive metrics including backlinks, keywords, traffic, and ranking data. Customize which metrics to return and how results are ordered.

Appends one or more JSON objects to the end of the specified dataset. The entire request is rejected with a 400 error if any item fails schema validation; payloads must not exceed 5 MB.

Approves a pending access request, granting the requester access to the associated target object. Use this to fulfill access requests that have been reviewed and authorized.

Archive an email sequence to mark it as inactive and automatically finish all contacts currently enrolled in it. Only the sequence owner or users with full access sharing permissions can perform this action, and a master API key is required.

Assign multiple accounts to a different owner within your team's Apollo account. This operation requires a master API key and allows bulk reassignment of account ownership.

Reassign multiple contacts to a different owner within your Apollo account. This operation allows you to bulk update contact ownership across your team.

Adds up to 25 requests to a specified request queue in a single batch operation. Returns arrays of successfully processed and unprocessed requests, with unprocessed entries recommended for retry using exponential backoff.

Batch-deletes up to 25 requests from a specified request queue, identified by their ID or uniqueKey. Any requests that fail due to rate limiting or internal errors are returned in the response for retry, with exponential backoff recommended.

Retrieve metadata for multiple contract addresses in a single request. Efficiently fetch contract information such as name, symbol, and decimals for a batch of addresses.

Retrieve metadata for multiple NFT contracts in a single request. Supports up to 100 tokens across Ethereum, Polygon, Arbitrum, Optimism, Base, World Chain, and other supported networks.

Triggers a new build for a specified Actor version, compiling its source code and dependencies into a runnable image. Returns the resulting build object, which may reflect a terminal or transitional status depending on wait time.

Create up to 100 accounts in a single request with intelligent deduplication. The endpoint returns newly created accounts and existing matches separately without modifying existing accounts.

Create up to 100 contacts in a single request with optional deduplication and bulk label assignment. The endpoint intelligently separates newly created contacts from existing ones in the response.

Create multiple tasks in a single request, with one task generated per contact. Returns a success status and array of created tasks. Requires a master API key.

Update multiple accounts simultaneously with common or individual field changes. Supports updating up to 1000 accounts per request, with optional asynchronous processing when applying uniform updates.

Update multiple contacts simultaneously with common field values. Supports updating up to 100 contacts per request, with automatic asynchronous processing for larger batches.

Calculates the Absolute Price Oscillator (APO) technical indicator for a given equity, measuring momentum by comparing two exponential moving averages. Returns APO values at your specified time interval.

Calculates the Average Directional Movement Index (ADX) for a given equity or forex pair, returning trend strength values across your specified time interval and period.

Calculate advanced analytics metrics for one or more financial symbols over a fixed time window, including statistical measures like returns, variance, drawdown, and correlation analysis.

Calculates the Aroon technical indicator for a given equity or forex pair, returning Aroon Up and Aroon Down values to identify trend direction and strength.

Calculates the Aroon oscillator (AROONOSC) technical indicator for a given equity symbol. The Aroon oscillator measures the difference between Aroon-Up and Aroon-Down, helping identify trend strength and direction changes.

Calculates Bollinger Bands technical indicator values for a given equity or forex pair, providing upper, middle, and lower bands based on standard deviation multipliers applied to a moving average.

Calculates the Commodity Channel Index (CCI) technical indicator for a given equity or forex pair, returning CCI values across a specified time series at your chosen interval.

Calculates the double exponential moving average (DEMA) for a given equity symbol, providing smoothed price trend analysis across various time intervals and historical periods.

Calculates exponential moving average (EMA) values for a given equity or currency pair over a specified time interval and period.

Calculates the rate of change (ROC) technical indicator for an equity, measuring the percentage change in price over a specified period. Returns ROC values at your chosen time interval.

Calculates the Kaufman Adaptive Moving Average (KAMA) for a given equity symbol, providing adaptive trend-following values that adjust to market volatility and noise.

Calculates Moving Average Convergence/Divergence (MACD) technical indicator values for a given equity or forex pair, returning MACD line, signal line, and histogram data across specified time intervals.

Calculate MACD (Moving Average Convergence Divergence) with customizable moving average types for technical analysis of equity price movements. Returns MACD line, signal line, and histogram values.

Calculates the midpoint values (average of highest and lowest prices) for an equity over a specified period and time interval.

Calculates the midpoint price (MIDPRICE) indicator for an equity over a specified period and time interval. MIDPRICE is computed as the average of the highest high and lowest low prices within each interval.

Calculates momentum (MOM) technical indicator values for a given equity symbol. Returns momentum measurements based on price changes over a specified time period and interval.

Calculates the Chande Momentum Oscillator (CMO) for a given equity, providing momentum-based technical analysis values across specified time intervals and historical periods.

Calculates the Money Flow Index (MFI) technical indicator for a given equity symbol. MFI measures buying and selling pressure by analyzing price and volume data over a specified time period and interval.

Calculates the rarity score for each attribute of a specific NFT by analyzing how uncommon each attribute is within the collection. Available on Ethereum mainnet and Polygon (mainnet and Mumbai testnet).

Calculates the Percentage Price Oscillator (PPO) for an equity, a momentum indicator that measures the relationship between two exponential moving averages. Returns PPO values across a specified time interval and historical period.

Calculates the rate of change ratio (ROCR) technical indicator for an equity, measuring the percentage change in price over a specified period. Returns ROCR values at your chosen time interval.

Calculates the Relative Strength Index (RSI) technical indicator for a given equity or forex pair over a specified time period and interval.

Calculates the simple moving average (SMA) for a given equity or currency pair over a specified time interval and period. Returns SMA values based on your chosen price type (open, close, high, or low).

Calculate the Stochastic Relative Strength Index (STOCHRSI) for a given equity symbol. Returns STOCHRSI values at your specified time interval and lookback period.

Calculates the Tilson T3 triple exponential moving average for a given equity symbol. Returns smoothed price data based on your specified time interval and period.

Calculates the Triple Exponential Moving Average (TEMA) for a given equity symbol, providing smoothed price trend analysis across various time intervals.

Calculates the triangular moving average (TRIMA) for a given equity symbol across specified time intervals. TRIMA is a double-smoothed moving average that emphasizes mid-range price data.

Calculates the 1-day rate of change of a triple smooth exponential moving average (TRIX) for a given equity, providing momentum analysis based on the specified time interval and price series.

Calculates the Ultimate Oscillator (ULTOSC) technical indicator for a given equity symbol and time interval. The Ultimate Oscillator is a momentum indicator that combines multiple timeframes to identify overbought and oversold conditions.

Calculate the volume weighted average price (VWAP) for intraday time series data of a given equity, helping identify fair value and trend direction based on price and volume.

Calculates weighted moving average (WMA) values for a given equity symbol across specified time intervals. Returns a time series of WMA data points based on your chosen price type and lookback period.

Cancel the scheduled delivery of an email. This prevents a scheduled email from being sent.

Charge for one or more occurrences of a configured pay-per-event (PPE) billing event within a specific Actor run. Must be called from within the Actor run using the same API token that started the run.

Checks whether a record exists in a key-value store under a specific key without retrieving its value. Useful for lightweight existence checks before performing read or write operations.

Check the current open or closed status of major global trading venues across equities, forex, and cryptocurrency markets.

Determines whether a specific NFT token was received as an airdrop, defined as an NFT minted to a user address in a transaction sent by a different address. Available on Ethereum mainnet and Polygon (mainnet, amoy, and mumbai).

Verify whether a wallet address holds any NFTs from a specific contract. Supports ERC721 and ERC1155 tokens across Ethereum and multiple Layer 2 networks including Polygon, Arbitrum, Optimism, and Base.

Checks whether a specific NFT contract is flagged as spam by Alchemy. This helps identify potentially fraudulent or low-quality NFT collections across supported blockchain networks.

Determines whether an NFT token was distributed as an airdrop by checking if it was minted to a user address in a transaction sent by a different address.

Verifies whether a specific wallet address holds at least one NFT from a given collection. Supports both ERC721 and ERC1155 token standards, and accepts wallet addresses in ENS format on Ethereum Mainnet.

Crawl multiple URLs from a base domain with configurable filtering, depth limits, and webhook notifications. Supports path-based inclusion/exclusion patterns, subdomain traversal, and concurrent scraping with rate limiting.

Create a new account (company) in your Apollo team database. Note that Apollo does not deduplicate accounts, so creating an account with the same name, domain, or details as an existing account will result in a duplicate entry rather than an update. Requires a master API key.

Creates a new Actor on the Apify platform with the specified configuration, including source code versions, run options, and publishing settings. At least one version of the source code must be defined; set isPublic to true along with a title and categories to list the Actor in Apify Store.

Creates a new environment variable for a specific version of an Actor. Requires a name and value, with an optional flag to mark the variable as secret.

Creates a new version of an Actor by specifying a version number and source type along with the corresponding source details. The source type determines which additional properties are required (e.g., a Git repository URL for GIT_REPO, a tarball URL for TARBALL).

Creates a new allocation and returns the full record of the newly created allocation.

Create custom prompts for Brand Radar reports to customize monitoring and analysis. This operation is free and does not consume API units.

Create a brand radar report that monitors brand mentions across AI-powered data sources. This operation is free and does not consume API units.

Creates a new Tetra browser session with configurable user agent, profile, proxy, and lifecycle settings. Returns session details needed to connect and interact with the browser.

Creates a new budget with the specified configuration. Use this to define spending limits and tracking parameters for a project, team, or time period.

Add a new contact to your Apollo account. By default, deduplication is disabled; enable it by setting `run_dedupe` to true to prevent creating duplicate contacts.

Create a custom field in your Apollo account to capture unique details about contacts, accounts, or deals. Custom fields enable your team to store specialized information and personalize outreach sequences.

Creates a new dataset for storing structured data and returns its object. If a name is provided and a dataset with that name already exists, the existing dataset object is returned instead.

Create a new deal in your Apollo account to track account activity, including deal value, ownership, and pipeline stage. Requires a master API key.

Creates a new enum option and appends it to the specified custom field's list of selectable values. A custom field supports up to 500 enum options (including disabled ones); locked fields can only be modified by the user who locked them.

Creates a new goal within a specified workspace or team. Returns the full record of the newly created goal.

Creates a new key-value store and returns its store object. If a store with the specified name already exists, the existing store is returned instead of creating a duplicate.

Create a new custom status that can be assigned to leads in your pipeline. This allows you to define custom workflow stages beyond the default statuses.

Creates a new membership linking a Team or User to a goal, project, portfolio, custom type, or custom field. Returns the full record of the newly created membership.

Initiates an export request for an entire Asana organization. Asana processes and completes the export asynchronously after the request is submitted.

Log phone calls made through external systems (such as Orum or Nooks) into Apollo. This endpoint records call metadata and outcomes but cannot initiate calls. Requires a master API key.

Creates a new portfolio in a specified workspace with a given name. Note that portfolios created via the API will not include default UI state (such as the 'Priority' custom field) to allow integrations to define their own initial configuration.

Create a new project by specifying a target URL, protocol, and matching scope. The project will be assigned to the specified owner or the workspace owner by default.

Creates a new project brief for the specified project, returning the full record of the newly created brief. Project briefs provide a structured summary of project goals, context, and key information.

Instantiates a new project from an existing project template, returning an asynchronous job that handles the creation process. Supports mapping template date variables and roles to specific calendar dates and users at instantiation time.

Creates a new project within the specified workspace or organization. If the workspace is an organization, a team must also be provided to share the project with.

Creates a new status update on a specified project and returns the full record of the newly created status. Note: this endpoint is deprecated; new integrations should use the `/status_updates` route instead.

Creates a billing rate for a specific resource (user or placeholder) within a parent project, defining the monetary value charged for that resource's time.

Create multiple records in a table. Submit up to 10 record objects in a single request, with cell values keyed by field name or field ID. Returns an array of newly created record IDs.

Creates a new request queue and returns its object, or returns the existing queue object if a queue with the given name already exists. Unnamed queues are subject to the platform's data retention policy.

Initiates an asynchronous bulk export of workspace resources (tasks, teams, or messages) in gzip-compressed JSON Lines format. Export progress can be monitored via the jobs endpoint, and the resulting file is accessible for 30 days after completion.

Creates a new schedule with the specified configuration, including timing, timezone, and associated actions. Returns the fully created schedule object upon success.

Creates a new actor task with the specified configuration, including the target actor, build version, timeout, and memory settings. Returns the full task object upon successful creation.

Creates a new team within the current workspace. Use this to organize members and resources under a named group.

Creates a new project shared with the specified team. Returns the full record of the newly created project.

Creates a new webhook that triggers HTTP POST requests to a target URL when specified Actor or task events occur. Use an idempotency key to safely retry creation without duplicating webhooks.

Permanently deletes the specified Actor and all associated data. This action is irreversible.

Permanently deletes a finished actor run. Only completed runs can be deleted, and only by the user or organization that initiated the run.

Permanently deletes a specific version of an Actor's source code. This action is irreversible and removes the version along with its associated configuration.

Permanently deletes a specific environment variable from a given Actor version. This action cannot be undone.

Permanently deletes an existing allocation by its unique identifier. Returns an empty data record upon successful deletion.

Permanently deletes a specific attachment by its unique identifier. Returns an empty data record upon successful deletion.

Remove custom prompts from a Brand Radar report. This operation is free and does not consume API units.

Permanently deletes an existing budget by its unique identifier. Returns an empty data record upon successful deletion.

Permanently deletes a specific Actor build by its ID. The current default build for an Actor cannot be deleted; only users with build permissions for the Actor may perform this action.

Delete a specific bundle notification by its ID. This operation permanently removes the bundle notification from the system.

Remove competitors from a Rank Tracker project. This operation is free and does not consume any API units.

Permanently deletes an existing custom field by its unique identifier. Note that locked custom fields can only be deleted by the user who originally locked the field.

Permanently delete a Custom Object instance by its unique identifier. This action cannot be undone.

Permanently deletes a specific dataset and its associated data. This action is irreversible and removes the dataset from the account.

Permanently deletes a specific extension by its unique identifier. This action is irreversible and removes the extension and its associated data.

Permanently deletes an existing goal by its unique identifier. Returns an empty data record upon successful deletion.

Permanently deletes a key-value store and all of its contents. This action is irreversible and removes the store along with all stored key-value pairs.

Permanently removes a single record from a key-value store by its key. The store itself and all other records remain unaffected.

Remove one or more keywords from an existing keyword list. Specify the keyword list by its ID and provide the keywords to be deleted.

Remove one or more keywords from a Rank Tracker project. This operation is free and does not consume API units.

Permanently removes an existing membership from a goal, project, portfolio, custom type, or custom field. Returns an empty data record upon successful deletion.

Delete an existing outcome from the system. Associated calls and meetings will retain their references to this outcome, but it will no longer be available for assignment to new calls or meetings.

Permanently deletes an existing portfolio by its unique identifier. Returns an empty data record upon successful deletion.

Permanently deletes an existing project by its unique identifier. This action is irreversible and returns an empty data record upon success.

Permanently deletes an existing project brief by its unique identifier. Returns an empty data record upon successful deletion.

Permanently deletes a specific project status update by its unique identifier. Note: this endpoint is deprecated; new integrations should use the status updates route instead.

Permanently deletes an existing project template by its unique identifier. This action is irreversible and returns an empty data record upon success.

Permanently removes a specific request from a request queue by its ID. Use this to discard requests that are no longer needed for processing.

Permanently deletes a rate by its unique identifier. This action cannot be undone.

Permanently deletes a single record from a table. This action cannot be undone.

Delete multiple records from a table by their record IDs. Supports batch deletion of up to 10 records in a single request.

Releases a lock on a specific request in a queue, making it available for other clients to process. Only the client that originally locked the request (via the lock head operation) can delete its lock.

Permanently deletes a request queue and all its associated data. This action is irreversible and removes the queue identified by its ID or name.

Permanently deletes a schedule by its unique identifier. This action cannot be undone.

Remove a Send As Association by its unique identifier. This operation permanently deletes the specified Send As Association, preventing further use of that sending identity.

Permanently deletes the specified actor task and all associated configuration. This action is irreversible and removes the task from the account.

Permanently deletes a webhook by its unique identifier. This action is irreversible and will stop all event notifications associated with the webhook.

Creates a duplicate of an existing portfolio and returns an asynchronous job that handles the duplication process. Custom field settings and views are always copied; additional elements such as members, rules, and child projects can be optionally included.

Creates an asynchronous duplication job that copies an existing project into a new project, with configurable options for which elements (members, tasks, dates, etc.) to include. Returns a job object that can be polled to track duplication progress.

Enrich company data by domain to retrieve detailed organizational information including industry, revenue, employee counts, funding details, and contact information. Each call consumes credits from your Apollo pricing plan.

Enrich company data for up to 10 organizations in a single request. Returns enriched information including industry, revenue, employee count, funding details, phone numbers, and locations.

Enrich contact and professional data for up to 10 people in a single request. Apollo uses the provided person details to identify and match records, then returns enriched information with optional email, phone, and waterfall verification.

Enrich data for a single person by matching against the Apollo database. Provide identifying information such as name, email, domain, or LinkedIn profile to locate and return enriched contact details. Optionally reveal personal emails and phone numbers, or enable waterfall enrichment for additional data discovery.

Initiates an asynchronous graph export job for a goal, team, portfolio, or project. Use the jobs endpoint to monitor progress; exports exceeding 1,000 tasks are cached for 4 hours, with subsequent requests returning the cached result.

Retrieves US Treasury yield data for a specified maturity timeline at daily, weekly, or monthly intervals. Data sourced from the Federal Reserve's official market yield on constant maturity securities.

Retrieve detailed information for a specific account (company) in your Apollo database. Requires a master API key.

Retrieves a complete summary of the authenticated account's limits, current usage cycle, and usage statistics, equivalent to the Limits page in the Apify console.

Retrieves full details for a specific Actor, including its configuration, settings, and metadata. Use this to inspect an Actor before running it or to verify its current state.

Retrieves full details about a specific Actor build, including its status, timing, and resource usage. Supports synchronous waiting via an optional timeout parameter to avoid polling when monitoring build completion.

Retrieves details of a specific environment variable for a given Actor version. If the variable is marked as secret, its value will be omitted from the response.

Retrieves all details about a specific Actor run, including its status, timing, and usage statistics. Optionally waits synchronously for the run to finish, eliminating the need for repeated polling.

Retrieves detailed information about a specific version of an Actor, including its configuration and metadata. Useful for inspecting the exact state of a particular Actor version.

Retrieves Chaikin A/D oscillator (ADOSC) technical indicator values for a specified equity symbol and time interval, with optional historical month selection and EMA period customization.

Retrieves Average Directional Movement Index Rating (ADXR) values for a specified equity, providing trend strength analysis over a chosen time interval and historical period.

Retrieves the complete record for a single allocation, including all associated details and metadata. Use this to fetch full information about a specific allocation by its unique identifier.

Retrieves global aluminum prices from the International Monetary Fund via the Federal Reserve Economic Data (FRED) service, available in monthly, quarterly, or annual time intervals.

Retrieve details for a specific AS2 partner by ID. Returns the partner's configuration and connection information.

Retrieves Average True Range (ATR) technical indicator values for a specified equity, showing volatility measurements over a chosen time interval and period.

Retrieves the full record for a single attachment, including its metadata and download URL. Requires the attachments:read scope.

Retrieve backlink statistics for a target domain or URL on a specific date. Returns metrics about incoming links based on your specified scope and protocol.

Retrieves Balance of Power (BOP) technical indicator values for a specified equity symbol at your chosen time interval. Optionally filter results to a specific month in history.

Retrieve annual and quarterly balance sheet data for a specified equity, with normalized fields mapped to GAAP and IFRS taxonomies. Data is typically updated on the same day the company reports its latest earnings and financials.

Retrieves Brent (Europe) crude oil prices from the U.S. Energy Information Administration via FRED. Data is available in daily, weekly, or monthly intervals.

Retrieve browser usage chart data for a project, showing visitor distribution across different browsers over a specified time period with configurable granularity.

Retrieve a chart of browser version performance metrics including visitor counts and session statistics over a specified time period.

Retrieves the complete record for a single budget, including all associated details and metadata. Use this to inspect a specific budget by its unique identifier.

Retrieves the log output for a specific actor build. Supports real-time log streaming while the build is in progress.

Retrieves annual and quarterly cash flow statements for a specified equity, with normalized fields mapped to GAAP and IFRS taxonomies. Data is typically updated on the same day the company reports its latest earnings and financial results.

Retrieves Chaikin A/D line (Accumulation/Distribution) values for a given equity, showing the relationship between price and volume to identify buying and selling pressure.

Retrieves global coffee prices from the International Monetary Fund (IMF) across different time horizons. Data represents the global price of Other Mild Arabica coffee sourced from the Federal Reserve Bank of St. Louis.

Retrieve high-level metadata and contract information for an NFT collection using its OpenSea slug. Supported across Ethereum and multiple Layer 2 networks including Polygon, Arbitrum, Optimism, and Base.

Retrieves the global price index for all commodities across different time periods. Data is sourced from the International Monetary Fund (IMF) Global Price Index and provided by the Federal Reserve Bank of St. Louis.

Retrieve comprehensive company information including financial ratios and key metrics for a specified equity ticker. Data is typically updated on the same day the company reports its latest earnings and financial results.

Retrieve detailed information for a specific contact in your Apollo database. This endpoint returns enriched contact data including email addresses, phone numbers, and other profile information.

Retrieve web analytics chart data aggregated by continent. This endpoint is free to use and does not consume API units.

Retrieves global copper prices from the International Monetary Fund (IMF) via the Federal Reserve Economic Data (FRED) service, available in monthly, quarterly, or annual time intervals.

Retrieves global corn prices from the International Monetary Fund (IMF) via FRED (Federal Reserve Bank of St. Louis) in your choice of monthly, quarterly, or annual time intervals.

Retrieves global cotton prices from the International Monetary Fund via the Federal Reserve Economic Data (FRED) service, available in monthly, quarterly, or annual time intervals.

Retrieve web analytics chart data aggregated by country with configurable time granularity and filtering. This endpoint is free and does not consume API units.

Retrieves monthly or semiannual Consumer Price Index (CPI) data for the United States, which measures inflation levels across the broader economy.

Retrieves real-time intraday price data for a cryptocurrency, including open, high, low, close prices and trading volume at specified time intervals.

Retrieves daily historical price and volume data for a cryptocurrency traded against a specific fiat currency. Data is updated daily at midnight UTC and includes prices quoted in both the target market currency and USD.

Retrieves monthly historical price and volume data for a cryptocurrency traded against a specific fiat or crypto market currency. Data is updated daily at midnight UTC and includes prices quoted in both the market currency and USD.

Retrieves weekly historical price and volume data for a cryptocurrency traded against a specified fiat currency. Data is updated daily at midnight UTC and includes prices quoted in both the target market currency and USD.

Retrieve the current authenticated user's identity and account information. Returns the user ID, associated OAuth scopes (if applicable), and email address (if the token has user.email:read scope).

Retrieves the complete metadata definition for a specific custom field, including type-specific properties such as enum options, validation rules, and display settings.

Retrieve a single Custom Object instance by its unique identifier. Returns the complete object data for the specified Custom Object.

Retrieves the complete record for a single custom type by its unique identifier. Use this to inspect the full definition and configuration of a specific custom type.

Retrieves daily adjusted OHLCV (open, high, low, close, volume) time series data for an equity, including split and dividend adjustments. Supports up to 20+ years of historical data with flexible output sizing.

Retrieves daily OHLCV (open, high, low, close, volume) time series data for a specified equity, covering 20+ years of historical data. Choose between compact (latest 100 data points) or full historical dataset.

Retrieves metadata and storage information for a specific dataset by its ID. Note that item count fields may lag up to 5 seconds behind actual data; use the list dataset items endpoint to retrieve the dataset's contents.

Retrieves field-level statistics for a specified dataset. Returns aggregated metrics such as value counts, null rates, and type distributions for each field in the dataset.

Retrieve complete details about a specific deal in your Apollo account, including deal owner, monetary value, stage, and associated account information. Requires a master API key.

Retrieves the default build for a specified Actor, optionally waiting synchronously for the build to reach a terminal state. No authentication token is required, though unauthenticated requests will have certain usage cost fields omitted from the response.

Retrieve device analytics chart data showing visitor distribution across different devices over a specified time period. This endpoint is free and does not consume API units.

Retrieves the Directional Movement Index (DX) technical indicator values for a specified equity symbol, time interval, and calculation period. Optionally returns historical data for a specific month.

Retrieve historical and declared future dividend distributions for a specified equity ticker symbol.

Retrieve comprehensive SEO metrics for a domain or URL, including keyword rankings, traffic estimates, and search volume data for a specified date.

Retrieve historical performance metrics for a domain or URL over a specified date range, with options to customize time intervals, volume calculations, and protocol scope.

Retrieve the domain rating for a target domain or URL on a specific date. Domain rating is a metric that indicates the authority and trustworthiness of a domain.

Retrieve historical Domain Rating data for a domain or URL over a specified time period, grouped by your chosen time interval.

Calculates the Hilbert transform dominant cycle period (HT_DCPERIOD) for a given equity, identifying the dominant cycle length in the price data at your specified time interval.

Retrieves the Hilbert transform dominant cycle phase indicator for a given equity symbol, helping identify the current phase position within the dominant market cycle.

Retrieves monthly data on manufacturers' new orders for durable goods in the United States, sourced from the U.S. Census Bureau via the Federal Reserve Economic Data (FRED) database.

Retrieve annual and quarterly earnings per share (EPS) data for a company, including analyst estimates and surprise metrics for quarterly periods.

Retrieves the earnings call transcript for a specified company and fiscal quarter, with historical data spanning over 15 years and enriched with LLM-based sentiment analysis.

Retrieve consensus earnings estimates for a specified equity, including annual and quarterly EPS and revenue projections, analyst count, and revision history.

Retrieve detailed statistics and activity information for a specific email sent through an Apollo sequence, including email contents, engagement metrics (opens and clicks), and recipient contact details.

Retrieve entry pages chart data for a project, showing visitor traffic patterns across specified time periods. This endpoint is free and does not consume API units.

Retrieves monthly time series data for a specified global equity, including open, high, low, close prices and trading volume for the last trading day of each month, covering 20+ years of historical data.

Retrieves comprehensive ETF profile data including key metrics (net assets, expense ratio, turnover) and detailed holdings information with allocation breakdown by asset types and sectors.

Retrieves the current exchange rate between two currencies, supporting both cryptocurrencies (e.g., BTC) and fiat currencies (e.g., USD, EUR).

Retrieve exit pages chart data for a project, showing which pages visitors exit from. Supports filtering, time-based aggregation, and customizable metrics selection.

Retrieve a single export by its unique identifier to check its current processing status or obtain a download URL once completed. Status values include: created, started, in_progress, done, and error.

Retrieves detailed information about a specific extension by its unique identifier. Use this to inspect extension configuration, status, or metadata.

Retrieves the current federal funds rate (interest rate) set by the United States Federal Reserve. Data is available at daily, weekly, or monthly intervals and sourced from the Federal Reserve Bank of St. Louis.

Retrieves real-time intraday time series data (open, high, low, close prices with timestamps) for a specified forex currency pair at your chosen time interval.

Retrieves monthly time series data for a forex currency pair, including open, high, low, and close prices. Data is updated in real-time, with the latest data point representing the current or partial month.

Retrieves weekly OHLC (open, high, low, close) time series data for a specified forex currency pair, with real-time updates reflecting the current or partial trading week.

Retrieve a specific form field set by its ID. Returns the complete configuration and structure of the requested form field set.

Retrieve daily forex time series data (open, high, low, close prices) for a specified currency pair, updated in real-time.

Retrieves the complete record for a single goal, including all associated fields and metadata. Requires the goals:read scope, with additional time_periods:read scope needed to access the time_period field.

Retrieves the complete record for a single goal relationship, including details about how two goals are linked. Use this to inspect the nature and status of a specific goal-to-goal connection.

Retrieves Hilbert transform phasor components for a given equity symbol, providing phase and amplitude information derived from the specified price series and time interval.

Retrieves Hilbert transform sine wave (HT_SINE) technical indicator values for a given equity symbol, useful for identifying cyclical trends and potential turning points in price movements.

Retrieves Hilbert transform instantaneous trendline (HT_TRENDLINE) technical indicator values for a specified equity, helping identify trend direction and potential reversal points.

Retrieve historical options chain data for a given equity symbol, including implied volatility and Greeks (delta, gamma, theta, vega, rho). Data spans 15+ years and defaults to the previous trading session if no date is specified.

Retrieves historical put-call ratios for an equity symbol, indicating market sentiment through the proportion of put to call options. Ratios below 0.6 suggest bullish sentiment, while ratios above 1.0 indicate bearish sentiment.

Retrieve annual and quarterly income statements for a specified equity, with normalized fields mapped to GAAP and IFRS taxonomies. Data is typically updated on the same day the company reports its latest earnings.

Retrieves historical OHLC (open, high, low, close) time series data for the NASDAQ Composite Index spanning decades of market data.

Retrieves annual inflation rates based on consumer prices for the United States, sourced from the Federal Reserve Economic Data (FRED) database via the World Bank.

Retrieves institutional ownership and holdings data for a specified equity, showing which institutions hold shares and their ownership percentages.

Retrieve intraday OHLCV (open, high, low, close, volume) time series data for an equity, with support for 20+ years of historical data and optional adjustment for splits and dividends.

Retrieve a specific invoice by its ID. Returns detailed invoice information including amounts, dates, and line items.

Retrieves the full record for a specific asynchronous job by its unique identifier. Useful for polling job status and accessing output resources such as new tasks, projects, portfolios, or templates created by the job.

Retrieves full details about a specific key-value store, including its configuration and metadata. Use this to inspect store properties before reading or writing data.

Retrieves the value stored under a specific key in a key-value store, returning the record with its original content type and encoding. Use the attachment parameter to fetch raw HTML content without Apify's security modifications.

Retrieve keyword performance metrics and search data for specified keywords in a target country, with optional filtering by domain/URL ranking position and historical volume trends.

Retrieve search volume metrics for a keyword broken down by country. Use this to understand geographic demand patterns and identify high-opportunity markets for your target keyword.

Retrieve historical search volume data for a keyword across a specified date range in a given country. Use this to analyze keyword popularity trends over time.

Retrieve browser language distribution data for web analytics with support for time-series charting across different granularities. This endpoint is free to use and does not consume API units.

Retrieves the most recent run of a specified Actor, with optional filtering by run status. Also serves as the base path for accessing the last run's default storages (log, key-value store, dataset, and request queue) via sub-endpoints.

Retrieves the most recent run of a specified actor task, with optional filtering by run status. Also serves as the base path for accessing the last run's default storages (log, key-value store, dataset, request queue) via sub-endpoints.

Retrieves MESA adaptive moving average (MAMA) values for a specified equity, allowing analysis of trend direction and momentum across multiple timeframes and price types.

Retrieve a specific Meeting activity by its unique identifier. Use this to fetch details about a scheduled or completed meeting.

Retrieves a single membership record by its unique identifier, returning details for any supported membership type including project, goal, portfolio, custom type, or custom field memberships.

Retrieves the Minus Directional Indicator (MINUS_DI) values for a given equity symbol, which measures downward price movement strength over a specified time period and interval.

Retrieves minus directional movement (MINUS_DM) technical indicator values for a specified equity, measuring downward price movement over a configurable time period and interval.

Retrieves monthly adjusted historical time series data for an equity, including split and dividend-adjusted prices, volumes, and dividends covering 20+ years of historical data.

Retrieves a complete summary of your usage for the current or a specified billing cycle, including storage, data transfer, and request queue usage with both an overall total and a daily breakdown.

Retrieves normalized average true range (NATR) technical indicator values for a specified equity symbol. NATR measures volatility as a percentage of the closing price, allowing for normalized comparison across different price levels.

Retrieves Henry Hub natural gas spot prices from the U.S. Energy Information Administration. Supports daily, weekly, and monthly price data sourced from the Federal Reserve Bank of St. Louis.

Retrieve a summary of attribute prevalence and distribution for an NFT collection. This endpoint analyzes trait frequency across all NFTs in a contract to provide insights into attribute rarity and composition. Available on Ethereum mainnet and Polygon (mainnet and Mumbai).

Retrieves the current floor prices for an NFT collection across supported marketplaces (OpenSea and Looksrare on Ethereum mainnet). Use this to monitor pricing trends and compare floor prices across different trading platforms.

Retrieve high-level metadata for an NFT contract or collection, including details about the contract itself. Supports ERC721 and ERC1155 contracts across Ethereum and multiple Layer 2 networks.

Retrieve detailed metadata for a specific NFT by its token ID and contract address. Supports ERC721 and ERC1155 tokens across Ethereum and multiple Layer 2 networks including Polygon, Arbitrum, Optimism, and Base.

Retrieves the current owner(s) of a specific NFT token. Supports ERC721 and ERC1155 contracts across Ethereum, Polygon, Arbitrum, Optimism, Base, World Chain, and other supported networks.

Retrieves monthly US nonfarm payroll employment figures from the Bureau of Labor Statistics, representing the total number of employed workers in the economy excluding farm workers, proprietors, and self-employed individuals.

Retrieves on-balance volume (OBV) technical indicator values for a specified equity, showing cumulative volume trends across your chosen time interval.

Retrieve a time-series chart of visitor counts and engagement metrics broken down by operating system versions. Data can be filtered, aggregated at different time intervals, and limited to specific OS versions.

Retrieve operating systems chart data for web analytics across a specified time period and granularity. This endpoint is free to use and does not consume API units.

Retrieve complete details about a specific organization from the Apollo database, including company information, contact data, and other organizational metadata. Requires a master API key for authentication.

Retrieves the current status and details of a previously requested organization export. Use this to check export progress or access the resulting download URL once complete.

Retrieve page content and metadata from a Site Audit project for a specific URL. This operation consumes 50 API units per request.

Retrieve historical performance data for specified pages from Google Search Console, including metrics like clicks, impressions, and average position over a configurable time period.

Retrieves parabolic SAR (Stop and Reverse) technical indicator values for a given equity at specified time intervals, useful for identifying potential trend reversals and stop-loss levels.

Retrieves Plus Directional Indicator (PLUS_DI) values for a given equity symbol, which measures upward price movement strength over a specified time period and interval.

Retrieves Plus Directional Movement (PLUS_DM) values for a given equity symbol. PLUS_DM is a technical indicator that measures upward price movement over a specified time period.

Retrieves the complete record for a single portfolio, including all associated metadata. Requires the portfolios:read scope.

Retrieves the complete details of a single portfolio membership record. Use this to inspect a specific user's membership relationship within a portfolio.

Retrieves historical price data for gold or silver across multiple time horizons (daily, weekly, or monthly intervals).

Retrieves the complete record for a single project, including all available fields and metadata. Requires the `projects:read` scope; accessing the `team` field additionally requires `teams:read`.

Retrieves the full record for a specific project brief, including its title, description, and associated project details.

Retrieves the complete details of a single project membership record, including the member's role and access level within the project.

Retrieves the complete record for a single project portfolio setting. Requires the `project_portfolio_settings:read` scope.

Retrieves the complete record for a single project status update by its unique identifier. Note: this endpoint is deprecated; new integrations should use the `/status_updates/{status_gid}` route instead.

Retrieves task count statistics for a specific project, including total, incomplete, and completed task counts (milestones are included). All fields are excluded by default and must be explicitly requested using opt_fields.

Retrieves the complete record for a single project template, including all its configuration and metadata. Requires the project_templates:read scope.

Retrieves a specific request from a request queue by its ID. Returns the full request details including URL, metadata, and processing status.

Retrieve overview metrics for all tracked keywords in a Rank Tracker project on a specific date, with support for filtering, sorting, and device-specific rankings.

Retrieves the complete record for a single rate, including all associated pricing details and metadata.

Retrieves annual or quarterly Real Gross Domestic Product data for the United States from the Federal Reserve Economic Data (FRED) database, sourced from the U.S. Bureau of Economic Analysis.

Retrieves quarterly Real GDP per Capita data for the United States from the Federal Reserve Economic Data (FRED) database, sourced from the U.S. Bureau of Economic Analysis.

Retrieves the realtime put-call ratio for a specified equity symbol, indicating market sentiment across the entire option chain and by expiration date. Lower ratios (≤0.6) suggest bullish sentiment with more call buying, while higher ratios (≥1.0) indicate bearish sentiment with more put buying.

Fetch real-time market quotes for multiple US-traded symbols in a single request, supporting up to 100 symbols with coverage of regular and extended trading hours.

Retrieves AI-powered recommendations (e.g., related products, frequently bought together) from Algolia's recommendation models. Supports multiple concurrent recommendation requests in a single call.

Retrieve a single record by its ID from a specified table. If the record is not found in the table, the system automatically searches across the entire base and returns the record if located.

Retrieve historical data on referring domains for a target domain or URL over a specified time period, with flexible grouping and protocol filtering options.

Retrieve referrers chart data for web analytics, showing traffic sources over a specified time period with configurable granularity and filtering options.

Retrieves metadata and configuration details for a specific request queue. Returns the full queue object including its properties and current state.

Retrieves the first N requests from the head of a request queue. Returns a `hadMultipleClients` flag indicating whether the queue has been accessed by more than one client, which helps SDKs determine local cache consistency.

Retrieves monthly Advance Retail Sales data for the United States from the U.S. Census Bureau, sourced through the Federal Reserve Economic Data (FRED) system.

Retrieves the log output for a specific Actor build or run. Supports real-time streaming for active runs and optional preservation of raw ANSI escape codes.

Retrieves a schedule object with all associated details by its unique identifier. Use this to inspect scheduling configuration, timing, and related metadata for a specific schedule.

Retrieves the execution log for a specific schedule, returning a JSON array of up to 1000 recent invocation records. Useful for auditing schedule activity and diagnosing execution history.

Retrieve Google Search Console performance metrics over a specified historical period, with options to filter by device type, search category, and time interval grouping.

Retrieve historical search volume data for a domain or URL over a specified time period. Use this to analyze organic search trends and traffic patterns.

Retrieve the current SERP overview for a tracked keyword, including top organic positions and ranking data. This endpoint is free and does not consume API units.

Retrieve SERP (Search Engine Results Page) overview data for a keyword in a specified country, including top organic positions and customizable metrics.

Retrieve Share of Voice data for brands across specified data sources. API unit consumption depends on prompt type: custom prompts only are free, while Ahrefs prompts follow standard pricing.

Retrieves quarterly shares outstanding data for a specified equity, including both basic and diluted share counts. Data is typically updated on the same day the company reports its latest earnings and financial results.

Retrieve a single Smart View by its unique identifier. Use this to fetch detailed information about a saved search view.

Retrieve source channels chart data with visitor analytics and session metrics, aggregated at the specified time granularity.

Retrieves the current live spot price for gold or silver in real-time market data.

Retrieves stochastic fast (STOCHF) technical indicator values for a given equity symbol. The STOCHF oscillator measures momentum by comparing closing prices to price ranges over a specified period.

Retrieves stochastic oscillator (STOCH) technical indicator values for a specified equity or forex pair at a given time interval. The stochastic oscillator measures momentum by comparing closing prices to price ranges over a defined period.

Retrieves historical stock split events for a given equity ticker symbol, including dates and split ratios.

Retrieve current workspace and API key limits and usage information. This request is free and does not consume any API units.

Retrieves global sugar prices from the International Monetary Fund (IMF) across different time horizons. Data is sourced from the Federal Reserve Bank of St. Louis FRED database.

Retrieve full details of a specific actor task, including its configuration, settings, and metadata. Use this to inspect an existing task before running or modifying it.

Retrieves the input configuration for a specified actor task. Returns the input object that defines the parameters passed to the actor when the task runs.

Retrieve the tax code accounting field configured for the current accounting connection. This field is used to classify transactions for tax reporting purposes.

Retrieves the full details for a single team by its unique identifier. Requires the teams:read scope.

Retrieve the owner(s) of a specific NFT token by contract address and token ID. Supports pagination to handle multiple owners.

Retrieve a chart of your top-performing pages with visitor metrics and engagement statistics, aggregated at your specified time granularity.

Retrieve traffic sources chart data with visitor metrics aggregated by your specified time granularity (hourly, daily, weekly, or monthly). This endpoint is free to use and does not consume API units.

Retrieves True Range (TRANGE) volatility values for a specified equity symbol at your chosen time interval. Optionally retrieve historical data for a specific month.

Retrieves the monthly unemployment rate for the United States, showing the percentage of unemployed individuals within the labor force. Data covers the civilian population aged 16 and older residing in the 50 states or District of Columbia.

Retrieve the historical URL Rating progression for a target domain or URL over a specified date range, with flexible time-based grouping options.

Retrieves current API key usage statistics and subscription details for the authenticated account. Useful for monitoring consumption limits and understanding remaining quota.

Retrieves public profile information for a specific user account, equivalent to what is visible on their public profile page. No authentication is required to call this endpoint.

Retrieve UTM parameters chart data for web analytics, visualizing traffic patterns across a specified UTM dimension over time. Use this to analyze campaign performance, traffic sources, or other UTM-tracked metrics.

Retrieve time-series chart data for web analytics metrics with configurable time granularity. Use this to visualize analytics trends across different time periods.

Retrieve cities chart data for web analytics showing visitor distribution across geographic locations. This endpoint is free to use and does not consume API units.

Retrieves full details of a specific webhook by its unique identifier. Returns all webhook configuration and metadata.

Retrieves a webhook dispatch record by its unique ID, returning full details about the dispatch event, status, and payload.

Retrieves weekly adjusted time series data for an equity, including open, high, low, close, adjusted close, volume, and dividend information. Covers 20+ years of historical data with the last trading day of each week as the reference point.

Retrieves weekly time series data for a specified equity, including open, high, low, close prices and trading volume for the last trading day of each week, covering 20+ years of historical data.

Retrieve global wheat prices from the International Monetary Fund (IMF) via FRED. Data is available in monthly, quarterly, or annual intervals.

Retrieves Williams' %R (WILLR) momentum oscillator values for a given equity symbol. This technical indicator measures the level of the closing price relative to the highest high over a specified period, helping identify overbought and oversold conditions.

Retrieves West Texas Intermediate (WTI) crude oil prices from the U.S. Energy Information Administration. Supports daily, weekly, and monthly price data sourced from FRED (Federal Reserve Bank of St. Louis).

Retrieves pending access requests for a specified target object, optionally filtered to a specific user. Useful for reviewing who is awaiting permission to access a resource.

Retrieve all available account stages in your Apollo account. Use the returned stage IDs to update individual accounts or bulk update account stages across multiple accounts.

Retrieves a paginated list of builds for a specific Actor, with each record containing basic build information. Results are sorted by start time in ascending order by default, supporting incremental fetching as new builds are created.

Retrieves a paginated list of all Actor runs for the authenticated user, with each item containing basic run metadata. Supports filtering by status and start time, and sorting in ascending or descending order.

Retrieves a paginated list of runs for a specific Actor, with each item containing basic run metadata. Supports filtering by status and start time, and sorting in ascending or descending order.

Retrieves all environment variables configured for a specific version of an Actor. Returns a list of environment variable objects, each containing the variable's key, value, and related metadata.

Retrieves all versions of a specific Actor, returning a list of Version objects with basic information about each version.

Retrieves a paginated list of webhooks associated with a specific Actor, returning basic information about each webhook. Results are sorted by creation date ascending by default, with a maximum of 1000 records per request.

Retrieves a paginated list of Actors the user has created or used, with options to filter to owned Actors only and sort by creation date or last run time. Returns up to 1000 records per request.

Retrieve AI-generated responses from multiple chatbot models for brand-related queries. API unit consumption depends on prompt type: custom prompts are free, while Ahrefs prompts follow standard pricing.

Retrieves a list of allocations, optionally filtered by project, assignee, or workspace. Useful for reviewing how resources are distributed across tasks and team members.

Retrieve anchor text (clickable words in hyperlinks) that point to a target domain or URL. Use this to analyze inbound link text and understand how external sites reference your target.

Retrieve anonymous search queries for a specific project and country. Returns query data filtered by date range with customizable columns, sorting, and filtering options.

Retrieves all attachments associated with a specified project, project brief, or task. For projects, this returns files in the 'Key resources' section; for tasks, this includes all associated files including inline images.

Retrieve site audit issues for a specific project. This operation costs 50 API units per request and returns issues from either a specified crawl date or the most recent available crawl.

Retrieve a paginated list of audit log events captured in a workspace or organization, sorted by creation time in ascending order. Supports filtering by time range, event type, actor, and resource, and can be polled continuously to stream new events as they are captured.

Retrieve page-level metrics and SEO data from a Site Audit crawl. This endpoint costs 50 API units per request and supports filtering, sorting, and comparison against previous crawls.

Retrieve health scores and performance metrics for Site Audit projects. Returns data from the most recent crawl by default, or from a specified crawl date if provided.

Retrieve all backlinks pointing to a target domain or URL, including detailed backlink profile metrics and historical data. Results can be aggregated, filtered, and sorted to analyze link quality and sources.

Retrieve historical mention data for a brand across specified AI chatbot models and date range. API consumption varies based on prompt type: custom prompts are free, while Ahrefs prompts follow standard pricing.

Retrieve historical impression data for brand mentions across AI chatbot platforms. API consumption varies based on prompt type: custom prompts are free, while Ahrefs prompts follow standard pricing.

Retrieve an overview of brand mentions data across specified data sources. API unit consumption depends on prompt type: custom prompts only are free, while Ahrefs prompts follow standard pricing.

Retrieve impressions overview data for Brand Radar across specified chatbot models and data sources. API unit consumption depends on prompt type: custom prompts are free, while Ahrefs prompts follow standard pricing.

Retrieve the Brand Radar prompts associated with a specific report. This operation is free and does not consume any API units.

Retrieve brand radar reports to monitor brand performance and competitive insights. This endpoint is free to use and does not consume any API units.

Retrieve historical Share of Voice data for brands across specified chatbot models and date ranges. API unit consumption depends on prompt type: custom prompts only are free, while Ahrefs prompts follow standard pricing.

Retrieve broken backlinks pointing to a target domain or URL. Returns backlinks that result in HTTP errors, with options to filter, sort, and aggregate results by domain or similarity.

Retrieve browser analytics data for a project, including visitor counts, bounce rates, and session duration metrics. This endpoint is free and does not consume API units.

Retrieve browser version statistics and metrics for web analytics. This endpoint is free to use and does not consume API units.

Retrieves all budgets associated with a given parent object. Returns at most one budget per parent, which must be a project.

Retrieves a paginated list of all builds for the authenticated user, with each entry containing basic build information. Records are sorted by start time and the endpoint returns a maximum of 1000 records per request.

Retrieve domains cited in AI visibility data from chatbot models and search engines. API unit consumption depends on the prompts parameter: requests using only custom prompts are free, while requests including Ahrefs prompts follow standard pricing.

Retrieve pages that cite your brand across specified chatbot models and AI overviews. API unit consumption depends on the prompts parameter: custom prompt data requests are free, while requests including Ahrefs prompt data incur standard API unit charges.

Retrieve competitor pages data for a Rank Tracker project on a specific date, filtered by device type and customizable metrics.

Retrieve an overview of competitor rankings for your tracked keywords on a specific date. This endpoint is free and does not consume API units.

Retrieve competitor performance metrics for tracked keywords on a specified date and device type. Use this to analyze how competitors rank for your target keywords and monitor their search visibility.

Retrieve all available contact stages in your Apollo account. Use the returned stage IDs to update individual contacts or bulk update contact stages across multiple contacts.

Retrieve web analytics metrics aggregated by continent for a specified project and time period. This endpoint is free to use and does not consume API units.

Retrieve performance metrics broken down by country for a target domain or URL on a specific date. Useful for analyzing geographic traffic distribution and keyword performance across regions.

Retrieve all errors encountered during a specific crawl job. Returns detailed error information to help diagnose and troubleshoot crawling issues.

Retrieve click-through rate (CTR) metrics aggregated by search position for a specified date range. This endpoint is free to use and does not consume API units.

Retrieve all custom fields configured in your Apollo account. This endpoint provides a complete inventory of custom field definitions available for use across your organization.

Retrieve all custom fields associated with custom objects in your organization. This operation returns the complete list of custom fields that have been defined for your custom object types.

Retrieves all custom types associated with a specified project. Use `opt_fields` to request additional fields beyond the default compact representation.

Retrieves items stored in a dataset, supporting multiple output formats (JSON, JSONL, XML, HTML, CSV, XLSX, RSS) with options for pagination, field filtering, sorting, and data transformation. Use this to export or inspect dataset contents produced by an Actor run.

Retrieves a paginated list of datasets accessible to the user, including basic metadata for each. Supports sorting, filtering by ownership, and optionally including unnamed datasets.

Retrieve all available deal stages in your Apollo account. Use the stage IDs returned by this endpoint when creating or updating deals through the Apollo API.

Retrieve device analytics data for a project, including metrics such as user counts, sessions, and engagement by device type. Results can be filtered, sorted, and scoped to a specific time range.

Retrieve Google Search Console performance metrics aggregated by device type (desktop, mobile, tablet) for a specified date range.

Retrieve expected earnings release dates for companies over a specified time horizon. Filter by a specific company symbol or view the full market earnings calendar.

Retrieve all linked email accounts and inboxes used by your team in Apollo. Returns account IDs that can be used with sequence operations. Requires a master API key.

Retrieve a list of email activities, with each result representing a single email message. Optionally filter results by specifying a maximum number of records to return.

Retrieve entry pages analytics data for a project, showing which pages users first land on. Supports filtering by date range and result limits.

Retrieve exit pages analytics data for a project, showing which pages users exit from most frequently. Supports filtering, sorting, and date range specification.

Retrieve a list of all exports with optional pagination control. Use the limit parameter to restrict the number of results returned.

Retrieve outgoing external anchor links from a target domain or URL. Results can be filtered by search scope, protocol, and custom expressions, with configurable sorting and pagination.

Retrieve all fields available in your Apollo account, with optional filtering by source type. Requires a master API key for authentication.

Retrieve a paginated list of form field sets. Use pagination to control the number of records returned per page.

Retrieves all custom field settings associated with a specific goal in compact form. Use opt_fields to request additional fields beyond the default compact representation.

Retrieves compact goal relationship records for a specified supported goal, allowing you to explore how goals are connected within your workspace.

Retrieves a list of compact goal records, optionally filtered by workspace, team, portfolio, project, task, or time period. Requires the goals:read scope.

Retrieve keywords from Google Search Console data for a specified date range. This operation is free and does not consume API units.

Retrieve Google Search Console metrics aggregated by country for a specified date range. This endpoint is free to use and does not consume API units.

Retrieve page performance metrics from Google Search Console, including impressions, clicks, and rankings for specified date ranges and filters.

Retrieves a complete catalog of all supported index symbols with their full names. Use this to discover available indices for market data queries.

Retrieve insider transactions (SEC Form 4 filings) for a specified company, including historical records of trades made by key stakeholders such as executives, founders, and board members.

Retrieves all integrations connected to the authenticated user's account. Returns a paginated list of integration records up to the specified limit.

Retrieve outgoing internal anchor links from a target domain or URL. Results can be filtered, ordered, and scoped by search mode and protocol.

Retrieve a paginated list of invoices. Use the per_page parameter to control the number of results returned per page.

Retrieve a list of upcoming IPO events scheduled in the US market over the next 3 months.

Retrieves a paginated list of keys from a specified key-value store, including metadata about each key's associated value such as size. Supports filtering by collection or key prefix.

Retrieves a paginated list of key-value stores accessible to the user, including basic metadata for each store. Results are sorted by creation date ascending by default, supporting incremental pagination as new stores are created.

Retrieve the historical ranking data for keywords associated with a target domain or URL across a specified date range, with options to group results by time interval and filter by protocol.

Retrieve historical Google Search Console keyword performance data with optional filtering by device type, country, and date range. Data can be grouped by daily, weekly, or monthly intervals.

Retrieve all keywords from a specified keyword list. This operation is free and does not consume any API units.

Retrieve historical keyword position data for a project, aggregated into position ranges over a specified time period. Use this to analyze ranking trends and performance across different time intervals.

Retrieve browser language statistics for a project, showing how visitors are distributed across different language preferences. This endpoint is free to use and does not consume API units.

Retrieve domains that link to your target domain or URL, with customizable filtering, sorting, and column selection for link analysis.

Retrieve a list of active or delisted US stocks and ETFs as of a specific date or the latest trading day, enabling equity research on asset lifecycle and survivorship.

Retrieve all lists created in your Apollo account. Use this endpoint to discover available lists before creating contacts or performing other list-based operations. Requires a master API key.

Retrieve available locations and supported languages for a specified country. This is a free operation that does not consume API units.

Retrieve the top 20 gainers, losers, and most actively traded stocks in the US market. Historical data is returned by default, with real-time or 15-minute delayed data available for premium members.

Retrieves compact membership records for a given parent resource (goal, project, portfolio, custom type, or custom field), optionally filtered by a specific member. Alternatively, when no parent is specified, returns all memberships of a given subtype for a specific member by combining the member and resource_subtype parameters.

Retrieves all wallet addresses that own NFTs from a specified ERC721 or ERC1155 contract, with optional token balance details per owner.

Retrieves all NFT collections owned by a specified address on Ethereum. Returns collection details with optional metadata to support portfolio analysis and collection discovery.

Retrieves all wallet addresses that own NFTs from a specific contract. Supports ERC721 and ERC1155 tokens across Ethereum and multiple Layer 2 networks including Polygon, Arbitrum, Optimism, and Base.

Retrieves all NFT contracts owned by a specified address. Optionally returns detailed metadata and supports filtering by spam confidence level and custom ordering.

Retrieves NFT sales transactions that have occurred through on-chain marketplaces. Supports filtering by block range, marketplace, collection, token ID, and trade participant role. Available on Ethereum (Seaport, Wyvern, X2Y2, Blur, LooksRare, Cryptopunks), Polygon (Seaport), and Optimism (Seaport) mainnets.

Retrieves all NFTs currently owned by a specified address, with optional filtering by contract, metadata inclusion, and spam confidence levels.

Retrieves all NFTs currently owned by a specified wallet address. Supports Ethereum, Polygon, Arbitrum, Optimism, Base, and other major networks with optional filtering, metadata inclusion, and custom ordering.

Retrieves all NFTs associated with a specific NFT collection across Ethereum and supported Layer 2 networks including Polygon, Arbitrum, Optimism, and Base. Supports pagination and optional metadata inclusion.

Retrieves all NFTs associated with a specific NFT contract address. Supports ERC721 and ERC1155 standards across Ethereum and multiple Layer 2 networks including Polygon, Arbitrum, Optimism, and Base.

Retrieve notes associated with a specific contact, account, opportunity, calendar event, or conversation. At least one relation parameter must be provided to filter results, with support for sorting and pagination.

Retrieve operating system versions analytics data for a specified project, with optional filtering, sorting, and date range selection.

Retrieve analytics data for operating systems across your project. This endpoint provides insights into visitor behavior by operating system and is available at no cost.

Retrieve all deals created in your Apollo account. This endpoint requires a master API key and returns a complete list of opportunities for your team.

Identify organic search competitors for a target domain or URL by analyzing shared keyword rankings in a specific country and date.

Retrieve organic keywords that drive traffic to a target domain or URL, with metrics for a specified date. Results can be filtered, sorted, and customized to show specific data columns.

Retrieve current job postings for a specific organization to identify companies expanding headcount in strategically important areas. This endpoint is useful for competitive intelligence and hiring trend analysis.

Retrieve outlink statistics for a target domain or URL. This beta endpoint provides insights into outbound links, though data may not perfectly match the Ahrefs UI and accuracy improvements are ongoing.

Retrieve historical ranking data for pages from a target domain or URL over a specified time period. Results can be grouped by daily, weekly, or monthly intervals and filtered by search scope and ranking position.

Retrieve historical page performance metrics from Google Search Console, including impressions, clicks, and rankings over a specified time period.

Retrieve the best performing pages for a target domain or URL ranked by backlink count. Use this to identify which pages attract the most external links and understand your site's link profile.

Retrieve the best-performing pages for a target domain or URL ranked by the number of internal links pointing to them. Use this to identify which pages are most linked internally and understand your site's link structure.

Retrieve pages grouped by traffic volume ranges for a domain or URL. Useful for identifying high-traffic pages and traffic distribution patterns across your site.

Retrieve paid search pages for a target domain or URL, showing which pages are generating paid search traffic on a specified date.

Retrieves a compact list of all parent goals associated with a specified goal. Useful for traversing goal hierarchies and understanding how a goal rolls up into broader objectives.

Retrieve all pending organization invitations that have been sent but not yet accepted. Use this to track outstanding invites and their status.

Retrieves all custom field settings configured on a specific portfolio, returned in compact form. Requires the portfolios:read scope.

Retrieves a paginated list of items within a specified portfolio in compact form. Useful for inspecting the contents of a portfolio, such as projects or other resources it contains.

Retrieves a list of portfolio memberships in compact representation. You must provide either a portfolio ID, a portfolio and user combination, or a workspace and user combination to filter results.

Retrieves all membership records for a specified portfolio, returning compact representations of each member. Optionally filter results by a specific user.

Retrieves a compact list of portfolios owned by the current API user within a specified workspace. Service Accounts can optionally filter by owner or retrieve all portfolios across the workspace.

Retrieve the list of competitors tracked for a specific project. This operation is free and does not consume any API units.

Retrieves all custom field settings configured on a specific project, returned in compact form. Use opt_fields to request additional field data beyond the default compact representation.

Retrieve all keywords tracked for a specific project in Rank Tracker. This operation is free and does not consume any API units.

Retrieves all membership records for a specified project, showing which users belong to it. Optionally filter results to a single user and control pagination with a per-page limit.

Retrieves all project portfolio settings associated with a specific project, returned as a compact representation. Requires the project_portfolio_settings:read scope.

Retrieves all compact project status update records for a given project. Note: this endpoint is deprecated — new integrations should use the `/status_updates` route instead.

Retrieves compact records for all project templates available in a given team or workspace. Requires the project_templates:read scope.

Retrieve your projects with optional filtering by owner, access type, and keyword tracking status. This operation is free and does not consume any API units.

Retrieves a paginated list of requests from a specified request queue. Use exclusiveStartId and limit to page through large queues efficiently.

Retrieves a list of rate records associated with a parent project, optionally filtered to a specific user or placeholder resource. Modifying placeholder rates requires an Enterprise or Enterprise+ plan.

Retrieves all reactions matching a specific emoji on a given object, such as a status update or story. Returns a paginated list of reactions filtered by the specified emoji base character.

Retrieve realtime US options data with full market coverage. Option chains are automatically sorted by expiration date (chronological) and then by strike price (low to high).

Retrieve referring domains data for a target domain or URL, with filtering and sorting capabilities to analyze backlink sources.

Retrieve referrer traffic sources and their associated metrics for a project, with optional filtering, sorting, and date range selection.

Discover related keywords that top-ranking pages rank for or mention, including keywords they also target and topics they discuss. Use this to identify keyword opportunities and content gaps around your target search terms.

Retrieve a list of repositories integrated with LaunchDarkly's engineering insights. Optionally expand the response to include associated project details for each repository.

Retrieves a paginated list of the user's request queues, returning basic metadata for each. Results are sorted by creation date ascending by default, supporting incremental fetching as new queues are created.

Retrieves all events that have occurred on a resource (task, project, or goal) since a given sync token was created. Returns up to 100 events per request, with a new sync token to paginate forward through additional events.

Retrieves a paginated list of schedules created by the user. Results are sorted by creation date ascending by default, with a maximum of 1000 records per request.

Retrieve metadata about supported Users, Groups, and extension attributes in the system. Use this to discover available schema definitions and their properties.

Retrieve search performance metrics aggregated by search result position. This endpoint provides free access to performance data without consuming API units.

Retrieve a paginated list of Tetra browser session usage records for the authenticated user, with optional filtering by user, session, time range, and status.

Retrieve web analytics data grouped by source channels, including visitor counts, bounce rates, and session duration metrics. This endpoint is free and does not consume API units.

Retrieve a list of all spam contracts identified and marked by Alchemy. This endpoint is available only on paid tier accounts and supports multiple blockchain networks including Ethereum, Polygon, Arbitrum, Optimism, Base, and others.

Retrieves the list of publicly available Actors from the Apify Store, with support for keyword search, filtering, and sorting. Returns up to 1,000 results and supports pagination.

Retrieves a compact list of all subtasks belonging to a specified task. Useful for exploring task hierarchies and understanding nested work breakdowns.

Retrieve paginated records from a table with optional filtering, formatting, and view selection. Results are returned one page at a time (up to 100 records per page by default), with pagination support via offset tokens.

Retrieves all projects that contain a specified task. Returns a compact representation of each associated project.

Retrieve a paginated list of runs for a specific actor task, including essential metadata for each run. Results can be filtered by status and sorted ascending or descending by start time.

Retrieves all tags associated with a specific task, returned as compact tag representations. Requires the tags:read scope.

Retrieves a paginated list of webhooks associated with a specific Actor task. Results are sorted by creation date and capped at 1000 records per request.

Retrieves a paginated list of all actor tasks created or used by the authenticated user. Results are sorted by creation date and capped at 1000 records per request.

Retrieves all custom field settings associated with a specific team, returned in compact form. Use opt_fields to request additional field data beyond the default compact representation.

Retrieves all project templates belonging to a specified team, returning compact template records. Useful for discovering reusable project structures available within a team.

Retrieve the top-performing pages for a domain or URL, including organic search metrics such as traffic and rankings for a specified date.

Retrieve the top-performing pages for a project ranked by pageviews and other engagement metrics. Use filtering and date range parameters to analyze specific traffic patterns and time periods.

Retrieve traffic sources data for a project, showing where visitors are coming from. Results can be filtered by date range and custom criteria, with optional sorting and pagination.

Retrieve a complete list of email addresses that have been unsubscribed from communications. Use this to manage your unsubscribe list and ensure compliance with user preferences.

Retrieve all user IDs in your Apollo account. These IDs are essential for creating deals, accounts, tasks, and other resources that require user assignment.

Retrieve UTM parameter data for web analytics, grouped by a specified UTM dimension (source, medium, campaign, term, or content) with optional filtering and time range selection.

Retrieve web analytics metrics aggregated by city for a specified project. This endpoint is free to use and does not consume API units.

Retrieve web analytics metrics aggregated by country for a specified project and time period. Results can be filtered, sorted, and paginated to analyze geographic performance data.

Retrieve aggregated web analytics statistics for a project, with optional filtering, sorting, and date range constraints.

Retrieves a paginated list of webhook dispatches associated with the authenticated user. Results are sorted by creation date and capped at 1000 records per request.

Retrieves the list of dispatch records for a specific webhook, showing its delivery history and execution events.

Retrieves a paginated list of webhooks created by the authenticated user. Results are sorted by creation date and capped at 1000 records per request.

Retrieves a list of all custom fields defined in a given workspace or organization. Returns compact representations suitable for discovery and reference.

Retrieves compact records for all projects within a specified workspace. Note: this endpoint may time out for large domains; use the memberships endpoint to fetch projects for a specific team.

Retrieves compact tag records for all tags within a specified workspace. Useful for discovering and filtering available tags to organize and categorize work items.

Retrieves and locks a specified number of requests from the head of a request queue, preventing other clients or runs from accessing them for the duration of the lock period. Returns a flag indicating whether the queue has been accessed by multiple clients.

Transforms an active Actor run into a run of a different Actor with new input, seamlessly handing off work without creating a new run. The original run's default storages are preserved and the new input is stored in the same key-value store.

Extends the lock duration on a specific request in a queue, preventing other clients from acquiring it. Only the client that originally locked the request can prolong its lock.

Stores a value under a specific key in a key-value store, with the content type defined by the Content-Type header. Supports Gzip, Deflate, and Brotli compression via the Content-Encoding header to reduce payload size and improve upload speed.

Extracts structured data from a webpage using an AgentQL query or a natural language prompt. Accepts either a live URL or raw HTML as the data source.

Reboots a currently running Actor run by restarting its container, returning the updated run details. Only runs with a RUNNING status can be rebooted; any data not persisted to a key-value store, dataset, or request queue will be lost.

Submits a request to refresh the cached metadata for a specific NFT token. Supported on Ethereum (Mainnet & Sepolia), Polygon (Mainnet, Mumbai & Amoy), Arbitrum One, Optimism, and Base mainnets.

Rejects a pending access request for a target object, denying the requester permission to access the resource. Use this to explicitly decline access requests that should not be granted.

Removes a custom field setting from a specified goal, detaching the custom field and its associated data from the goal. Requires the goals:write scope.

Removes a custom field setting from a project, detaching it so the field no longer appears or collects data for that project. Requires projects:write scope.

Removes one or more followers (collaborators) from a specified goal. Returns the complete updated goal record reflecting the removed followers.

Removes a supporting relationship between a child resource and a parent goal, unlinking a goal, project, task, or portfolio that was previously set as a supporting resource.

Removes a custom field setting from a portfolio, detaching it so the field no longer appears or collects data for that portfolio. Requires portfolios:write scope.

Removes a specific item from a portfolio, unlinking it from the portfolio's collection. Returns an empty data block upon success.

Removes one or more users from the membership list of a specified portfolio. Returns the updated portfolio record reflecting the changes.

Removes one or more users from following a project without affecting their project membership status. Returns the updated project record.

Removes one or more users from the member list of a specified project. Returns the updated project record reflecting the new membership.

Repositions a specific enum option within a custom field's ordered list by placing it before or after another existing enum option. Locked custom fields can only be reordered by the user who locked the field.

Destructively update a single record in a table, clearing all unspecified cell values. Use this operation when you want to replace the entire record content with new values.

Replace multiple records in a table with a destructive update that clears all unincluded cell values. Supports upserting up to 10 records by matching on specified field(s).

Report a blockchain address as spam to help protect the network. This operation flags addresses suspected of malicious activity on supported chains including Ethereum, Polygon, Base, Arbitrum, Optimism, and others.

Submits an access request for a private project or portfolio, notifying the owner so they can grant or deny access.

Resubscribe an email address to receive messages from Close. Use this operation to restore messaging delivery for an email that was previously unsubscribed.

Restarts a finished Actor run (with status FINISHED, FAILED, ABORTED, or TIMED-OUT), resuming execution with the same storages and updating its status back to RUNNING. Optionally override the build, timeout, memory, or error-restart behavior from the original run.

Restarts a finished Actor run (with status FINISHED, FAILED, ABORTED, or TIMED-OUT) by restarting its container with the same storages, updating its status back to RUNNING. Optionally override the build, timeout, memory, and cost limits used for the resurrected run.

Starts an Actor run asynchronously and immediately returns a Run object without waiting for completion. Pass input data as the request body and use the returned run ID or defaultDatasetId to retrieve results later.

Runs a specific Actor synchronously, passing the request body as INPUT, and returns the Actor's OUTPUT from its default key-value store. If the Actor run exceeds 300 seconds, the response will return a 408 timeout status.

Runs a specific Actor synchronously without input and returns its dataset items directly in the response. The Actor must complete within 300 seconds; if it exceeds this limit or the connection breaks, a timeout error is returned.

Runs a specific Actor synchronously with the provided input payload and returns the resulting dataset items directly in the response. Supports the same output formatting and filtering options as the Get Dataset Items endpoint; times out with HTTP 408 if the Actor run exceeds 300 seconds.

Runs a specific Actor synchronously without input and returns its output directly in the response. The run must complete within 300 seconds; if it exceeds this limit or the connection breaks, a timeout error is returned.

Starts an Actor task run asynchronously and immediately returns a run object without waiting for completion. Optionally override the task's input configuration via the request body, and use the returned run ID to poll for results or fetch dataset output.

Runs an Actor task synchronously and returns its output directly in the response. The task must complete within 300 seconds; optionally, you can override the task's default input by providing a JSON payload.

Synchronously runs a specific actor task and returns its dataset items directly in the response. The task must complete within 300 seconds; if it exceeds this limit the request times out, though the underlying run continues executing.

Runs a specific actor task synchronously and returns its output directly in the response. The task must complete within 300 seconds; if it exceeds this limit or the connection drops, the request fails but the underlying run continues.

Runs an Actor task synchronously and returns the resulting dataset items directly in the response. Optionally override task input via the POST body and control output format, pagination, and field selection through query parameters.

Converts an existing project into a reusable project template by initiating an asynchronous job. Returns a job object that can be monitored for completion status.

Search for accounts that have been added to your team's Apollo database. Filter by name, stage, labels, and sort results by activity or creation date. Results are paginated with a maximum of 50,000 records (100 per page).

Search the Apollo database for companies using multiple filter criteria including domain, location, technology stack, and hiring activity. Results are paginated at 100 records per page (up to 500 pages, 50,000 record limit) and consume credits based on your Apollo plan.

Search for news articles related to companies in the Apollo database. Filter results by company IDs and optionally by news categories to find relevant coverage. Note: This operation consumes credits from your Apollo plan.

Search for contacts in your team's Apollo account by keywords, stage, or labels. Results are paginated with a maximum of 100 records per page, up to 500 pages (50,000 total records).

Search and filter contacts and leads using advanced query logic with support for complex conditions, text search, and related object queries. Returns paginated results with optional field selection and sorting.

Search for keywords across metadata of ERC-721 and ERC-1155 smart contracts. Currently available on Ethereum, Polygon, Arbitrum, Optimism, and Base networks.

Retrieve keyword search suggestions for a specified country. Returns relevant keyword variations and related search terms to help identify search opportunities in your target market.

Find keyword variations and related search terms with performance metrics for a specific country. Returns matching keywords based on search mode (exact phrase or term-based) with optional filtering and sorting capabilities.

Executes multiple search queries across one or more indices in a single request, useful for querying different indices simultaneously or applying varied filters to the same index.

Search live and historical market news with sentiment analysis across stocks, cryptocurrencies, forex, and economic topics from global news outlets.

Search for outreach emails created and sent through Apollo sequences by your team. Returns up to 50,000 records with pagination support (100 records per page, maximum 500 pages). Requires a master API key.

Search the Apollo database for people matching specified criteria such as job title, location, seniority, and employer technology stack. This API-optimized endpoint does not consume credits and returns up to 50,000 records without email addresses or phone numbers.

Search for phone calls made or received by your team using the Apollo dialer. Filter results by date range, duration, call direction, team members, contacts, call purposes, outcomes, and keywords.

Search and filter projects within a workspace using advanced criteria including text, ownership, membership, portfolio, dates, and custom fields. Results are eventually consistent and require a premium Asana account; use list_projects instead when immediate consistency after writes is needed.

Search for email sequences in your Apollo account by name. This endpoint requires a master API key and returns sequences matching your search criteria.

Search for financial symbols and market information by keywords. Returns matching symbols ranked by relevance with match scores to support custom filtering logic.

Search for tasks created in Apollo across your team. Returns up to 50,000 records with pagination support (100 records per page, maximum 500 pages). Requires a master API key.

Send a custom POST request directly to any Algolia REST API endpoint. Useful for accessing new or undocumented features not yet covered by dedicated methods.

Creates and attaches a progress metric to a specified goal, defining how goal completion is measured and tracked. If a metric already exists on the goal, it will be replaced entirely.

Syncs CSV data into a Sync API table. The CSV can contain up to 10,000 rows and 500 columns, with a maximum HTTP request size of 2 MB per sync run.

Sends a test dispatch to the specified webhook using a dummy payload. Useful for verifying that the webhook endpoint is correctly configured and reachable.

Unlocks all currently locked requests in the specified request queue that are held by the calling client. Within an Actor run, this releases locks held by both the current run and the same clientKey; outside a run, it releases all locks associated with the provided clientKey.

Update an existing account in your Apollo workspace. Requires a master API key and the account ID. You can modify account details such as name, domain, owner, stage, location, phone, and custom fields.

Updates the settings and configuration of an existing Actor by applying only the properties provided in the JSON request body. Returns the full updated Actor object after the changes are applied.

Updates an existing environment variable for a specific Actor version. Only the properties included in the request body will be modified; omitted properties retain their current values.

Updates a specific version of an Actor with the provided fields, leaving unspecified properties unchanged. Send a JSON payload with only the fields you want to modify.

Updates an existing allocation by replacing only the fields provided in the request body, leaving all unspecified fields unchanged. Returns the complete updated allocation record.

Update the configuration of a Brand Radar report, including its monitoring frequency. This operation is free and does not consume API units.

Updates an existing budget by replacing only the fields provided in the request body, leaving all unspecified fields unchanged.

Update an existing call record in Apollo with new details such as status, timing, duration, purpose, outcome, and notes. Requires a master API key.

Update an existing contact in your Apollo account. Modify contact details such as job title, account association, location, stage, and custom fields. List assignments are replaced entirely when provided.

Update the stage assignment for multiple contacts in your Apollo account. Specify the contacts to update and the target stage they should be assigned to.

Updates an existing custom field by its unique identifier, applying only the fields provided in the request body while leaving unspecified fields unchanged. Note that a custom field's type cannot be changed, enum options must be managed separately, and locked fields can only be updated by the user who locked them.

Updates a dataset's name and general access level by dataset ID or username-scoped name. Returns the full updated dataset object.

Updates an existing enum option on a custom field, allowing changes to its name, color, or enabled state. Locked custom fields can only be modified by the user who locked them, and at least one enabled enum option must remain on the field.

Updates an existing goal by replacing only the fields provided in the request body, leaving all other fields unchanged. Returns the complete updated goal record.

Updates the current numeric value of an existing goal metric, allowing progress tracking against a defined target. Requires the goal to already have a numeric metric configured; returns the complete updated goal metric record.

Updates an existing goal relationship by replacing only the fields provided in the request body, leaving all other fields unchanged. Returns the complete updated goal relationship record.

Updates a key-value store's name and general access level using the provided JSON payload. Returns the updated store object reflecting the applied changes.

Updates an existing membership by replacing only the fields provided in the request body, leaving all other fields unchanged. Supports memberships on goals, projects, portfolios, custom types, and custom fields.

Update an existing deal in your Apollo account. Modify deal details such as name, monetary value, owner, stage, and close date to keep your pipeline current.

Updates an existing portfolio by replacing only the fields provided in the request body, leaving all other fields unchanged. Returns the complete updated portfolio record.

Updates an existing project by its unique identifier, applying only the fields provided in the request body while leaving unspecified fields unchanged. Returns the complete updated project record.

Update the access setting for a project to control whether it is private or shared. This operation is free and does not consume any API units.

Updates an existing project brief by replacing only the fields provided in the request body, leaving all other fields unchanged. Returns the complete updated project brief record.

Updates an existing project portfolio setting by replacing only the fields provided in the request body, leaving all other fields unchanged. Returns the complete updated project portfolio setting record.

Updates an existing request in a queue, allowing you to modify its properties or mark it as handled. Setting `handledAt` to the current time removes the request from the head of the queue and releases any lock on it.

Updates the monetary value of an existing rate record. Only the rate field can be modified; all other fields remain unchanged.

Partially update a single record in a table by specifying only the fields you want to change. Unspecified fields remain unchanged. Table names and IDs can be used interchangeably.

Update or upsert up to 10 records in a table. When performUpsert is enabled, records matching the specified merge fields are updated; non-matching records are created. Only fields included in the request are modified; all other fields remain unchanged.

Updates a request queue's name and resource access level by submitting a JSON payload with the desired changes. Returns the full updated request queue object upon success.

Updates an Actor run's status message and/or general resource access level. Use this to communicate progress to users via the Apify Console UI or to control who can view the run and its associated storages and logs.

Updates an existing schedule by its ID, applying only the properties provided in the request body while leaving unspecified properties unchanged. Returns the full updated schedule object.

Update the status of contacts within email sequences by marking them as finished, removing them entirely, or stopping their progress. Requires a master API key.

Update the settings, input configuration, and runtime options of an existing Actor task. Only properties included in the request body are modified; omitted properties retain their current values.

Updates the input configuration of a specific actor task by merging the provided JSON object with the existing input. Only the properties included in the request body are updated; omitted properties retain their current values.

Updates an existing webhook's configuration by its ID, applying only the properties provided in the JSON request body. Returns the full updated webhook object.

Upload a file attachment (up to 5 MB) directly to an attachment field in a record. The file must be provided as base64-encoded bytes along with its content type and filename.

Upload an extension package to the system, making it available for installation and use. Accepts a binary file representing the extension bundle.