The ultimate Social Graph endpoint - this returns a list of all the neighbors, i.e. the addresses the given address has interacted with, along with all the transfers to/from those neighbors. This can help you build your social applications quickly at a very low cost.
Token standards covered when determining neighbors: Native, ERC-20. [ERC-721 and ERC-1155 support is coming soon].
Syntax
GET /$CHAIN/v1/address/$ADDRESS/neighbors
Query params
You can use the following params in various combinations to further refine the output. These are common to retrievals over a block range or a time range.
Param
Default value
Note
allow_contract
empty
comma separated allow list of EVM addresses including “0x”
only the transfers for the specified contracts (i.e. tokens) are considered while identifying the neighbors
use "native" to specify the native currency
supports only ERC20 contracts [ERC-721, ERC-1155 support coming soon]
if empty, all the transfers will be considered to identify the neighbors
do not specify both this and block_contract
allow_cp
empty
comma separated allow list of EVM addresses including “0x”
only the specified counterparties are returned in the list of neighbors
use "native" to specify the Zero address, typically used for fee/burn/mint transactions
if empty, all the neighbors will be returned
do not specify both this and block_cp
block_contract
empty
comma separated block list of EVM addresses including “0x”
transfers for the specified contracts (i.e. tokens) are not considered while identifying the neighbors
use "native" to specify the native currency
supports only ERC20 contracts [ERC-721, ERC-1155 support coming soon]
if empty, all the transfers will be considered to identify the neighbors
do not specify both this and allow_contract
block_cp
empty
comma separated block list of EVM addresses including “0x”
specified counterparties are blocked from the list of neighbors
use "native" to specify the Zero address, typically used for fee/burn/mint transactions
if empty, all the neighbors will be returned
do not specify both this and allow_cp
details
all
a list of neighbors, along with the details of all the transfers (token, block, amount) with each neighbor, are returned by default
"summary": gets only a high level summary. It returns a list of neighbors along with only the number of transfers to and from that neighbor.
