You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The 9.0.0 release of /api/v2 includes breaking changes aimed at enforcing consistency across the API. This includes structural changes, deprecated field removals, and naming standardizations that were previously announced in the v8 release.
🩺 /api/v2/health Endpoint Update
Removed:latest_block from the root of the response.
Replacement: Use blocks.latest_block instead.
📛 Deprecated Fields Removed (As Announced in v8)
In line with the API v2 naming policy, the following legacy properties have been removed. Please ensure you're using their updated equivalents:
Full API response properties renaming list
❌ Removed
✅ Use Instead
address(hex string)
address_hash
transaction_count
transactions_count
holders
holders_count
holder_count
holders_count
validators_counter
validators_count
new_validators_counter_24h
new_validators_count_24h
active_validators_counter
active_validators_count
withdrawal_sum
withdrawals_sum
withdrawal_count
withdrawals_count
origination_address
origination_address_hash
outbox_address
outbox_address_hash
caller
caller_address_hash
destination
destination_address_hash
start_block
start_block_number
end_block
end_block_number
before_acc
before_acc_hash
after_acc
after_acc_hash
associated_l1_transaction
associated_l1_transaction_hash
l1_block_height
l1_block_number
blob_transaction_count
blob_transactions_count
contract_address
contract_address_hash
internal_id
number
l2_block_start
l2_start_block_number
l2_block_end
l2_end_block_number
slashing_status_is_slashed
(use structured field)
slashing_status_by_block
slashing.status_by_block
slashing_status_multiplier
slashing.status_multiplier
l1_transaction_count
l1_transactions_count
l2_transaction_count
l2_transactions_count
🧠 Smart Contract Object Changes
✅ Added
creation_status field added to the address object in responses.
Possible values: selfdestructed, failed, success
🔁 Renamed
Field status in the smart_contract object → renamed tocreation_status
❌ Removed
Field is_self_destructed removed from the endpoint: /api/v2/smart-contracts/:address_hash
⚠️ Action Required
These changes are not backward-compatible. If you're consuming these endpoints, please update your integrations immediately to avoid errors or data inconsistencies.
💡 New environment variables
New environment variables list
Variable
Description
Parameters
INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_ENABLED
If true, Indexer.Utils.EventNotificationsCleaner process starts. Implemented in #12738
Timeout before new attempt to append item to multichain DB main (blocks, transactions, addresses) export queue if it's full. Time format. Implemented in #12377.
If true, retry multichain search export fetcher doesn't run. Implemented in #12377. Replaced with INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_FETCHER.
Concurrency for retry multichain search export fetcher. Implemented in #12377. Replaced with INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_CONCURRENCY.
Timeout before new attempt to append item to retry multichain search export queue if it's full. Time format. Implemented in #12377. Replaced with INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT.
Maximum size of retry multichain search export queue. Implemented in #12377. Replaced with INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_MAX_QUEUE_SIZE.
1000
v8.1.0+
v9.0.0
API_RATE_LIMIT_TIME_INTERVAL
Time interval of rate limit. Implemented in #7148. Replaced with API_RATE_LIMIT_BY_KEY_TIME_INTERVAL, API_RATE_LIMIT_BY_WHITELISTED_IP_TIME_INTERVAL, API_RATE_LIMIT_UI_V2_WITH_TOKEN_TIME_INTERVAL, API_RATE_LIMIT_BY_ACCOUNT_API_KEY_TIME_INTERVAL, API_RATE_LIMIT_BY_IP_TIME_INTERVAL
The 9.0.0 release of /api/v2 includes breaking changes aimed at enforcing consistency across the API. This includes structural changes, deprecated field removals, and naming standardizations that were previously announced in the v8 release.
🩺 /api/v2/health Endpoint Update
Removed:latest_block from the root of the response.
Replacement: Use blocks.latest_block instead.
📛 Deprecated Fields Removed (As Announced in v8)
In line with the API v2 naming policy, the following legacy properties have been removed. Please ensure you're using their updated equivalents:
Full API response properties renaming list
❌ Removed
✅ Use Instead
address(hex string)
address_hash
transaction_count
transactions_count
holders
holders_count
holder_count
holders_count
validators_counter
validators_count
new_validators_counter_24h
new_validators_count_24h
active_validators_counter
active_validators_count
withdrawal_sum
withdrawals_sum
withdrawal_count
withdrawals_count
origination_address
origination_address_hash
outbox_address
outbox_address_hash
caller
caller_address_hash
destination
destination_address_hash
start_block
start_block_number
end_block
end_block_number
before_acc
before_acc_hash
after_acc
after_acc_hash
associated_l1_transaction
associated_l1_transaction_hash
l1_block_height
l1_block_number
blob_transaction_count
blob_transactions_count
contract_address
contract_address_hash
internal_id
number
l2_block_start
l2_start_block_number
l2_block_end
l2_end_block_number
slashing_status_is_slashed
(use structured field)
slashing_status_by_block
slashing.status_by_block
slashing_status_multiplier
slashing.status_multiplier
l1_transaction_count
l1_transactions_count
l2_transaction_count
l2_transactions_count
🧠 Smart Contract Object Changes
✅ Added
creation_status field added to the address object in responses.
Possible values: selfdestructed, failed, success
🔁 Renamed
Field status in the smart_contract object → renamed tocreation_status
❌ Removed
Field is_self_destructed removed from the endpoint: /api/v2/smart-contracts/:address_hash
⚠️ Action Required
These changes are not backward-compatible. If you're consuming these endpoints, please update your integrations immediately to avoid errors or data inconsistencies.
💡 New environment variables
New environment variables list
Variable
Description
Parameters
INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_ENABLED
If true, Indexer.Utils.EventNotificationsCleaner process starts. Implemented in #12738
Timeout before new attempt to append item to multichain DB main (blocks, transactions, addresses) export queue if it's full. Time format. Implemented in #12377.
If true, retry multichain search export fetcher doesn't run. Implemented in #12377. Replaced with INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_FETCHER.
Concurrency for retry multichain search export fetcher. Implemented in #12377. Replaced with INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_CONCURRENCY.
Timeout before new attempt to append item to retry multichain search export queue if it's full. Time format. Implemented in #12377. Replaced with INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT.
Maximum size of retry multichain search export queue. Implemented in #12377. Replaced with INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_MAX_QUEUE_SIZE.
1000
v8.1.0+
v9.0.0
API_RATE_LIMIT_TIME_INTERVAL
Time interval of rate limit. Implemented in #7148. Replaced with API_RATE_LIMIT_BY_KEY_TIME_INTERVAL, API_RATE_LIMIT_BY_WHITELISTED_IP_TIME_INTERVAL, API_RATE_LIMIT_UI_V2_WITH_TOKEN_TIME_INTERVAL, API_RATE_LIMIT_BY_ACCOUNT_API_KEY_TIME_INTERVAL, API_RATE_LIMIT_BY_IP_TIME_INTERVAL
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
-
🚨 API v2 – Breaking Changes in Release 9.0.0
The 9.0.0 release of
/api/v2includes breaking changes aimed at enforcing consistency across the API. This includes structural changes, deprecated field removals, and naming standardizations that were previously announced in the v8 release.🩺
/api/v2/healthEndpoint Updatelatest_blockfrom the root of the response.blocks.latest_blockinstead.📛 Deprecated Fields Removed (As Announced in v8)
In line with the API v2 naming policy, the following legacy properties have been removed. Please ensure you're using their updated equivalents:
Full API response properties renaming list
address(hex string)address_hashtransaction_counttransactions_countholdersholders_countholder_countholders_countvalidators_countervalidators_countnew_validators_counter_24hnew_validators_count_24hactive_validators_counteractive_validators_countwithdrawal_sumwithdrawals_sumwithdrawal_countwithdrawals_countorigination_addressorigination_address_hashoutbox_addressoutbox_address_hashcallercaller_address_hashdestinationdestination_address_hashstart_blockstart_block_numberend_blockend_block_numberbefore_accbefore_acc_hashafter_accafter_acc_hashassociated_l1_transactionassociated_l1_transaction_hashl1_block_heightl1_block_numberblob_transaction_countblob_transactions_countcontract_addresscontract_address_hashinternal_idnumberl2_block_startl2_start_block_numberl2_block_endl2_end_block_numberslashing_status_is_slashedslashing_status_by_blockslashing.status_by_blockslashing_status_multiplierslashing.status_multiplierl1_transaction_countl1_transactions_countl2_transaction_countl2_transactions_count🧠 Smart Contract Object Changes
✅ Added
creation_statusfield added to theaddressobject in responses.Possible values:
selfdestructed,failed,success🔁 Renamed
statusin thesmart_contractobject → renamed tocreation_status❌ Removed
is_self_destructedremoved from the endpoint:/api/v2/smart-contracts/:address_hashThese changes are not backward-compatible. If you're consuming these endpoints, please update your integrations immediately to avoid errors or data inconsistencies.
💡 New environment variables
New environment variables list
INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_ENABLEDtrue,Indexer.Utils.EventNotificationsCleanerprocess starts. Implemented in #12738Version: v9.0.0+
Default:
trueApplications: Indexer
INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_INTERVALVersion: v9.0.0+
Default:
2mApplications: Indexer
INDEXER_DB_EVENT_NOTIFICATIONS_CLEANUP_MAX_AGEVersion: v9.0.0+
Default:
5mApplications: Indexer
INDEXER_SIGNED_AUTHORIZATION_STATUS_BATCH_SIZEVersion: v9.0.0+
Default:
10Applications: Indexer
MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_BATCH_SIZEVersion: v9.0.0+
Default:
10Applications: Indexer
MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_CONCURRENCYVersion: v9.0.0+
Default:
1Applications: Indexer
MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_TIMEOUTVersion: v9.0.0+
Default:
0Applications: Indexer
MIGRATION_REINDEX_BLOCKS_WITH_MISSING_TRANSACTIONS_ENABLEDVersion: v9.0.0+
Default:
falseApplications: Indexer
MIGRATION_RESTORE_OMITTED_WETH_TOKEN_TRANSFERS_BATCH_SIZEVersion: v6.8.0+
Default:
50Applications: API, Indexer
MIGRATION_MERGE_ADJACENT_MISSING_BLOCK_RANGES_BATCH_SIZEVersion: v9.0.0+
Default:
100Applications: Indexer
API_RATE_LIMIT_CONFIG_URLVersion: v9.0.0+
Default: (empty)
Applications: API
API_RATE_LIMIT_BY_KEY_TIME_INTERVALVersion: v9.0.0+
Default:
1sApplications: API
API_RATE_LIMIT_BY_WHITELISTED_IP_TIME_INTERVALVersion: v9.0.0+
Default:
1sApplications: API
API_RATE_LIMIT_UI_V2_WITH_TOKEN_TIME_INTERVALVersion: v9.0.0+
Default:
1sApplications: API
API_RATE_LIMIT_BY_ACCOUNT_API_KEY_TIME_INTERVALVersion: v9.0.0+
Default:
1sApplications: API
INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_FETCHERtrue, multichain DB main (blocks, transactions, addresses) export fetcher doesn't run. Implemented in #12377.Version: v9.0.0+
Default:
falseApplications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_BATCH_SIZEVersion: v9.0.0+
Default:
1000Applications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_CONCURRENCYVersion: v9.0.0+
Default:
10Applications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUTVersion: v9.0.0+
Default:
1sApplications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_MAX_QUEUE_SIZEVersion: v9.0.0+
Default:
1000Applications: Indexer
INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_FETCHERtrue, multichain DB balances export fetcher doesn't run. Implemented in #12580.Version: v9.0.0+
Default:
falseApplications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_BATCH_SIZEVersion: v9.0.0+
Default:
1000Applications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_CONCURRENCYVersion: v9.0.0+
Default:
10Applications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUTVersion: v9.0.0+
Default:
1sApplications: Indexer
INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_BALANCES_QUEUE_MAX_QUEUE_SIZEVersion: v9.0.0+
Default:
1000Applications: Indexer
INDEXER_POLYGON_ZKEVM_BATCHES_IGNOREVersion: v9.0.0+
Default: (empty)
Applications: Indexer
INDEXER_OPTIMISM_MULTICHAIN_BATCH_SIZEVersion: v9.0.0+
Default:
100Applications: Indexer
CELO_UNRELEASED_TREASURY_CONTRACTCeloUnreleasedTreasurycore contract. Implemented in #12373.Version: v9.0.0+
Default: (empty)
Applications: Indexer
CELO_VALIDATORS_CONTRACTValidatorscore contract. Implemented in #12373.Version: v9.0.0+
Default: (empty)
Applications: Indexer
CELO_EPOCH_MANAGER_CONTRACTEpochManagercore contract. Implemented in #12373.Version: v9.0.0+
Default: (empty)
Applications: Indexer
⛔ Deprecated environment variables
Deprecated environment variables list
INDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_RETRY_FETCHERtrue,retrymultichain search export fetcher doesn't run. Implemented in #12377. Replaced withINDEXER_DISABLE_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_FETCHER.falseINDEXER_MULTICHAIN_SEARCH_DB_EXPORT_RETRY_BATCH_SIZEretrymultichain search export fetcher. Implemented in #12377. Replaced withINDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_BATCH_SIZE.INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_RETRY_CONCURRENCYretrymultichain search export fetcher. Implemented in #12377. Replaced withINDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_CONCURRENCY.INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_RETRY_ENQUEUE_BUSY_WAITING_TIMEOUTretrymultichain search export queue if it's full. Time format. Implemented in #12377. Replaced withINDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_ENQUEUE_BUSY_WAITING_TIMEOUT.INDEXER_MULTICHAIN_SEARCH_DB_EXPORT_RETRY_MAX_QUEUE_SIZEretrymultichain search export queue. Implemented in #12377. Replaced withINDEXER_MULTICHAIN_SEARCH_DB_EXPORT_MAIN_QUEUE_MAX_QUEUE_SIZE.API_RATE_LIMIT_TIME_INTERVALAPI_RATE_LIMIT_BY_KEY_TIME_INTERVAL,API_RATE_LIMIT_BY_WHITELISTED_IP_TIME_INTERVAL,API_RATE_LIMIT_UI_V2_WITH_TOKEN_TIME_INTERVAL,API_RATE_LIMIT_BY_ACCOUNT_API_KEY_TIME_INTERVAL,API_RATE_LIMIT_BY_IP_TIME_INTERVAL1s🚀 Features
creation_statusfield to address response (#12660)/api/v2/config/celoconvenience endpoint (#12238)🐛 Bug Fixes
index == 0(#12777)/api/v2/smart-contracts(#12767)txlistmethod (#12727)MarketHistoryon conflict clause (#12541)/api/v2/internal-transactions(#12701)add_0x_prefixfunction (#12514)⚡ Performance
txlsit&txlistinternalendpoints (#12774)⚙️ Miscellaneous Tasks
getcontractcreationandgetblocknobytimeendpoints (#12721)is_self_destructedfield in/api/v2/smart-contracts/{address_hash}response (#12239)This discussion was created from the release BlockScout v9.0.0.
Beta Was this translation helpful? Give feedback.
All reactions