v0.10 (beta)
api.onchain.industries/beta/query-one
This endpoint accepts a wallet, a username, or an email and returns a streams of module responses.
Your request to this endpoint must adhere to this schema.
query
string
Wallet, username, or email to generate a report on. Must be three or more characters long, have no spaces, nor special characters besides dashes, dots, and underscores. Not recommended to search wallets other than ones from chains we currently support.
string
options
optional
object Options
Optional configuration fields.
optional
object Options
options.
skip_maintenance
optional
boolean
True by default. If false, response will not skip modules under maintenance.
optional
boolean
options.
skip_negatives
optional
boolean
False by default. If true, response will skip modules that did not find any match.
optional
boolean
curl --request POST \
--url 'https://api.onchain.industries/beta/query-one' \
--header 'key: <your-key>' \
--header 'Content-Type: application/json' \
--data '{
"query": "<wallet or username>",
"options": {
"skip_maintenance": "true"
}
}'This endpoint response is a stream of ModuleResponse, a collection of all of the data found linked to any given platform.
data
object Data
The main content of the response, containing detailed information related to the profile.
object Data
data.
exists
boolean
True if there is an account in this platform directly linked to your query.
boolean
data.
profile_url
optional
string
The URL pointing to the profile associated with the data.
optional
string
data.
data
nullable
object data
Nested object containing additional data such as account details, social links, and metadata.
nullable
object data
data.
account_url
optional
string
The URL linking directly to the user's account.
optional
string
data.
bio
optional
string
A brief biography or description of the user.
optional
string
data.
joined
optional
date
The date when the user joined the platform.
optional
date
data.
updated
optional
date
The date when the user's profile data was last updated.
optional
date
data.
followers
optional
number
The number of followers the user has.
optional
number
data.
following
optional
number
The number of users that the profile is following.
optional
number
data.
usernames
optional
array of Usernames
A list of usernames associated with the user's profile.
optional
array of Usernames
usernames.
tags
optional
array of strings
Optional tags or labels associated with the username.
optional
array of string
usernames.
username
string
A specific username linked to the user's profile.
string
data.
wallets
optional
array of Wallets
A list of cryptocurrency wallets linked to the user.
optional
array of Wallets
wallets.
address
string
The wallet address associated with the user.
string
wallets.
tags
optional
array of strings
Optional tags or labels associated with the wallet address.
optional
array of string
data.
emails
optional
array of Emails
A list of email addresses associated with the user.
optional
array of Emails
emails.
address
string
The email address of the user.
string
emails.
tags
optional
array of strings
Optional tags or labels associated with the email address.
optional
array of string
data.
ens
optional
array of ENS
An array of Ethereum Name Service (ENS) domains linked to the user.
optional
array of ENS
ens.
ens
string
The ENS name associated with the user.
string
ens.
tags
optional
array of strings
Optional tags or labels associated with the ENS name.
optional
array of string
data.
ids
optional
array of IDs
An array of unique identifiers related to the user across this platform.
optional
array of IDs
ids.
id
string
The unique identifier related to the user.
string
ids.
tags
optional
array of strings
Optional tags or labels associated with the identifier.
optional
array of string
data.
images_url
optional
array of URLs
A list of image URLs associated with the user's profile.
optional
array of URLs
images_url.
url
string
The URL of an image linked to the user's profile.
string
images_url.
tags
optional
array of strings
Optional tags or labels associated with the image.
optional
array of string
data.
linked_accounts
optional
array of LinkedAccount
A list of other accounts linked to the user's profile on different platforms.
optional
array of LinkedAccount
linked_accounts.
platform
string
The platform name of the linked account.
string
linked_accounts.
profile_url
nullable
string
The URL to the linked account's profile.
nullable
string
linked_accounts.
username
nullable
string
The username associated with the linked account.
nullable
string
data.
links
optional
array of Links
A collection of external links related to the user's profile.
optional
array of Links
links.
url
string
The external URL associated with the user's profile.
string
links.
tags
optional
array of strings
Optional tags or labels associated with the URL.
optional
array of string
data.
names
optional
array of Names
A list of names associated with the user's profile.
optional
array of Names
names.
name
string
The name associated with the user's profile.
string
names.
tags
optional
array of strings
Optional tags or labels associated with the name.
optional
array of string
data.
nfts
optional
array of NFTs
A list of NFTs owned or associated with the user.
optional
array of NFTs
nfts.
address
string
The contract address of the NFT.
string
nfts.
chain
string
The blockchain on which the NFT resides.
string
nfts.
label
string
A label or description of the NFT.
string
nfts.
url
string
The URL where more information about the NFT can be found.
string
nfts.
tags
optional
array of strings
Optional tags or labels associated with the NFT.
optional
array of string
data.
soft_links
optional
array of SoftLinks
An array of other user accounts connected to the user, such as followers, following, etc.
optional
array of SoftLinks
soft_links.
data
string
The data or content related to the soft link.
string
soft_links.
data_type
string
The type of the data such as name, email, etc.
string
soft_links.
relationship
string
The relationship or connection between the user and the soft link.
string
data.
transactions
optional
array of Transactions
A list of transactions associated with the user.
optional
array of Transactions
transactions.
tags
optional
array of strings
Optional tags or labels associated with the transaction.
optional
array of string
transactions.
txn_hash
string
The transaction hash, uniquely identifying the transaction.
string
data.
dynamic
optional
array of DynamicField
An array of dynamic fields containing data points specific to the platform this account belongs to.
optional
array of DynamicField
dynamic.
description
nullable
string
A textual description of the dynamic field.
nullable
string
dynamic.
value
nullable
string
The actual value associated with the dynamic field.
nullable
string
dynamic.
name
string
The name or identifier of the dynamic field.
string
data.
obfuscated_data
optional
object Original
Obfuscated or anonymized data related to the user, including emails, IP addresses, and more.
optional
object Original
obfuscated_data.
emails
optional
array of Emails
A list of emails related to the user.
optional
array of Emails
emails.
count
number
The number of email addresses that have been obfuscated.
number
emails.
items
optional
array of strings
A list of obfuscated email addresses.
optional
array of string
obfuscated_data.
ip_addresses
optional
array of IP Addresses
A list of IP Addresses related to the user.
optional
array of IP Addresses
ip_addresses.
count
number
The number of IP addresses that have been obfuscated.
number
ip_addresses.
items
optional
array of strings
A list of obfuscated IP addresses.
optional
array of string
obfuscated_data.
links
optional
array of Links
A list of links related to the user.
optional
array of Links
links.
count
number
The number of links that have been obfuscated.
number
links.
items
optional
array of strings
A list of obfuscated links.
optional
array of string
obfuscated_data.
relative_links
optional
array of RelativeLinks
A list of relative links associated with the user.
optional
array of RelativeLinks
relative_links.
count
number
The number of relative links that have been obfuscated.
number
relative_links.
items
optional
array of strings
A list of obfuscated relative links.
optional
array of string
obfuscated_data.
usernames
optional
array of Usernames
A list of usernames associated with the user.
optional
array of Usernames
usernames.
count
number
The number of usernames that have been obfuscated.
number
usernames.
items
optional
array of strings
A list of obfuscated usernames.
optional
array of string
obfuscated_data.
wallets
optional
array of Wallets
A list of wallets associated with the user.
optional
array of Wallets
wallets.
count
number
The number of wallets that have been obfuscated.
number
wallets.
items
optional
array of strings
A list of obfuscated wallets.
optional
array of string
data.
original
optional
object Original
Response from the module, varies depending on the module. For details, please visit the platforms section. If exists equals false, this will be null.
optional
object Original
platform
object Platform
Details about the platform associated with the response data.
object Platform
platform.
url
string
The URL of the platform.
string
platform.
attributes
array of Attributes
A list of attributes related to the platform, such as its name and additional metadata.
array of Attributes
attributes.
name
string
The name of the specific platform attribute (e.g., current user count).
string
attributes.
value
string
The value associated with the platform attribute, corresponding to the attribute's name.
string
platform.
description
optional
string
A description of the platform, providing additional details about the platform's purpose or context.
optional
string
platform.
name
string
The name of the platform that is associated with the response data.
string
data_type
object DataType
Specifies the module type, which can either check account existence (checker), check and return data (checker+data), or check and return obfuscated information (checker+obfuscated).
object DataType
data_type.
description
string
A textual description of the data type.
string
data_type.
label
string
A label for the data type.
string
search_type
string
The type of search conducted to generate the response (e.g., username search, email search, etc.).
string
status
string
Current status of this module. Could be operational or under maintenance. By default, modules under maintenance are not returned by the API.
string
version
string
Indicates whether the platform data was obtained through stable(released) or experimental(beta) methods.
string
error
optional
string
A string that contains any error messages encountered during the request, if applicable.
optional
string
{
"platform": {
"name": "Lens",
"url": "https://lens.xyz/",
"description": "An open social network enabling users to own their content and connections, with a platform for developers to build decentralised applications.",
"attributes": []
},
"search_type": "evm",
"version": "released",
"status": "operational",
"data_type": {
"label": "checker+data",
"description": "Checker+Data modules check if an account exists on a given platform and also return some information"
},
"data": {
"exists": true,
"profile_url": null,
"original": {
"data": {
"result": {
"__typename": "Profile",
"id": "0x0187b3",
"ownedBy": {
"__typename": "NetworkAddress",
"address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
"chainId": 137
},
"txHash": "0xea49fbc5f55f08fc678b22ac861482c366941a19b87403dff7315f15d4c0ffee",
"createdAt": "2022-11-12T11:05:35.000Z",
"operations": {
"__typename": "ProfileOperations",
"id": "0x0187b3",
"isBlockedByMe": {
"__typename": "OptimisticStatusResult",
"value": false,
"isFinalisedOnchain": true
},
"isFollowedByMe": {
"__typename": "OptimisticStatusResult",
"value": false,
"isFinalisedOnchain": true
},
"isFollowingMe": {
"__typename": "OptimisticStatusResult",
"value": false,
"isFinalisedOnchain": true
},
"canBlock": false,
"canUnblock": false,
"canFollow": "NO",
"canUnfollow": false
},
"interests": [],
"guardian": null,
"invitesLeft": 0,
"onchainIdentity": {
"proofOfHumanity": false,
"ens": {
"name": "vitalik.eth"
},
"sybilDotOrg": {
"verified": false,
"source": null
},
"worldcoin": {
"isHuman": false
}
},
"followNftAddress": {
"__typename": "NetworkAddress",
"address": "0xf12D31b798dB234C55d9b50c3854F99dB6BddAea",
"chainId": 137
},
"followModule": null,
"metadata": null,
"handle": {
"__typename": "HandleInfo",
"id": "0xaf2caa1c2ca1d027f1ac823b529d0a67cd144264b2789fa2ea4d63a67c7103cc",
"fullHandle": "lens/vitalik",
"namespace": "lens",
"localName": "vitalik",
"suggestedFormatted": {
"full": "lens/@vitalik",
"localName": "@vitalik"
},
"linkedTo": {
"contract": {
"__typename": "NetworkAddress",
"address": "0xDb46d1Dc155634FbC732f92E853b10B288AD5a1d",
"chainId": 137
},
"nftTokenId": "0x0187b3"
},
"ownedBy": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
},
"sponsor": true,
"signless": true,
"invitedBy": null,
"stats": {
"id": "0x0187b3",
"followers": 38983,
"following": 7,
"comments": 12,
"posts": 44,
"mirrors": 2,
"quotes": 0,
"publications": 58,
"upvotes": 60127,
"downvotes": 2,
"upvoted": 3,
"downvoted": 0,
"collects": 0,
"countOpenActions": 0,
"upvoteReactions": 60127,
"downvoteReactions": 2,
"upvoteReacted": 3,
"downvoteReacted": 0
}
}
}
},
"data": {
"dynamic": [
{
"name": "Has Proof of Humanity",
"value": false,
"description": null
},
{
"name": "Interests",
"value": 0,
"description": null
},
{
"name": "Comments",
"value": 12,
"description": null
},
{
"name": "Posts",
"value": 44,
"description": null
},
{
"name": "Publications",
"value": 58,
"description": null
},
{
"name": "Upvotes",
"value": 60127,
"description": null
}
],
"usernames": [
{
"username": "lens/@vitalik",
"tags": [
"Handle"
]
},
{
"username": "@vitalik",
"tags": [
"Local name"
]
}
],
"followers": 38983,
"following": 7,
"wallets": [
{
"address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
"tags": [
"Profile owned by"
]
},
{
"address": "0xf12D31b798dB234C55d9b50c3854F99dB6BddAea",
"tags": [
"Follow NFT address"
]
},
{
"address": "0xDb46d1Dc155634FbC732f92E853b10B288AD5a1d",
"tags": [
"Contract linked to"
]
}
],
"transactions": [
{
"txn_hash": "0xea49fbc5f55f08fc678b22ac861482c366941a19b87403dff7315f15d4c0ffee"
}
],
"ens": [
{
"ens": "vitalik.eth",
"tags": [
"ENS name"
]
}
],
"joined": "2022-11-12T11:05:35.000Z"
}
}
}