Skip to content

Updated solana to reflect changes, introduced batch_labels #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MaghirSokker wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated solana to reflect changes, introduced batch_labels #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 109 additions & 0 deletions endpoint/batch_label.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,109 @@
---
title: "Batch Labels API"
api: "GET https://api-c.walletlabels.xyz/solana/label"
description: "This endpoint enables you to search and retrieve multiple labels by their addresses simultaneously.."
---

### Authorization

<ResponseField
name="x-api-key"
type="string"
default="demo-api-key-x-00000"
initialValue="demo-api-key-x-00000"
required
>
Your API key for authentication.
</ResponseField>

### Body
{" One of the two following queries options is required to run your query :"}

<ParamField query="eth" type="string" required>
Specify the Ethereum address for which you want to retrieve labels.
</ParamField>
<ParamField query="sol" type="string" required>
Specify the Solana address name for which you want to retrieve labels.
</ParamField>
### Response

<ResponseField name="data" type="array">
An array that encapsulates the labels corresponding to the addresses provided.

<Expandable title="Label Object">

<ResponseField name="address_name" type="string">
The designated name associated with the specific address.
</ResponseField>

{" "}

<ResponseField name="address" type="string">
The address for the label.
</ResponseField>

{" "}

<ResponseField name="label_type" type="string">
Categories to define the nature of the label.
</ResponseField>

{" "}

<ResponseField name="label_subtype" type="string">
Additional attributes for a
more granular understanding of the label.
</ResponseField>

{" "}

<ResponseField name="label" type="string">
The general name or title of the label.
</ResponseField>

{" "}

<ResponseField name="score" type="string">
The meta-score of the Ethereum label.
</ResponseField>
</Expandable>
</ResponseField>

<RequestExample>

```bash Example Request
curl --location --request GET 'https://api-c.walletlabels.xyz/batch_label?eth=0x5d446fc8dbd10ebacfe9a427ab5402586af98cd4,0x5d8ce06a40fb101895be5b6560931b92a1b3444f' \
--header 'Content-Type: application/json' \
--header 'x-api-key: demo-api-key-x-00000'
```

</RequestExample>

<ResponseExample>

```json Response
{
"data": {"batch_result":[
{
"address": "0x5d446fc8dbd10ebacfe9a427ab5402586af98cd4",
"address_name": "unfederalreserve: unwbtc token",
"label_type": "token",
"label_subtype": "token_contract",
"label": "unfederalreserve",
"score": 1.1
},
{
"address": "0x5d8ce06a40fb101895be5b6560931b92a1b3444f",
"address_name": "tagz token",
"label_type": "token",
"label_subtype": "token_contract",
"label": "tagz token",
"score": 1.1
}

]
}
}
```

</ResponseExample>
5 changes: 1 addition & 4 deletions endpoint/solana/label.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,13 @@ description: "Retrieve user-friendly labels for Solana EOAs (Externally Owned Ac
<ParamField query="address" type="string" required>
Specify the Solana address for which you want to retrieve labels.
</ParamField>
<ParamField query="label" type="string" required>
Specify the Solana address name for which you want to retrieve labels.
</ParamField>
<ParamField query="limit" type="string">
Specify number of shown results.
</ParamField>
### Response

<ResponseField name="data" type="array">
An array that encapsulates the labels corresponding to the Solana address provided.
An array that encapsulates the label corresponding to the Solana address provided.

<Expandable title="Label Object">

Expand Down
4 changes: 2 additions & 2 deletions endpoint/solana/search.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Account Search API (Beta)"
api: "GET https://api-c.walletlabels.xyz/solana/search"
description: "Retrieve user-friendly labels for Solana EOAs (Externally Owned Accounts) and Smart Contracts. Labels can be incredibly useful for categorizing your Solana interactions."
description: "This endpoint enables you to search and retrieve labels by their names. It's particularly useful for finding specific Solana accounts based on labels."
---

### Authorization
Expand Down Expand Up @@ -66,7 +66,7 @@ description: "Retrieve user-friendly labels for Solana EOAs (Externally Owned Ac
<RequestExample>

```bash Example Request
curl --location --request GET 'https://api-c.walletlabels.xyz/solana/search?search=nft&limit=1' \
curl --location --request GET 'https://api-c.walletlabels.xyz/solana/search?searchtext=nft&limit=1' \
--header 'Content-Type: application/json' \
--header 'x-api-key: demo-api-key-x-00000'
```
Expand Down