HashPack

https://docs.hashpack.app
Admin
HashPack is a Hedera wallet that empowers developers and creators by providing tools and resources...
Tokens:5,029
Snippets:71
Trust Score:9.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Query Documentation via HTTP GET

Source: https://docs.hashpack.app/llms.txt

Perform a GET request to the documentation index using the ask and goal parameters to receive a direct answer and relevant excerpts.

```http
GET https://docs.hashpack.app/dapp-developers/walletconnect.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### GET /dapp-developers/walletconnect.md

Source: https://docs.hashpack.app/llms.txt

Performs a natural language query against the documentation index to retrieve answers and relevant excerpts.

```APIDOC
## GET /dapp-developers/walletconnect.md

### Description
Perform an HTTP GET request on the documentation index with the `ask` parameter, and the optional `goal` parameter to retrieve answers and relevant excerpts from the documentation.

### Method
GET

### Endpoint
https://docs.hashpack.app/dapp-developers/walletconnect.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### Get Multiple Profiles Endpoint

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-multiple-profiles.md

The endpoint URL for retrieving profile information for multiple accounts.

```http
POST https://api.hashpack.app/user-profile/get-multiple
```

--------------------------------

### Get Profile Endpoint

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-single-profile.md

The endpoint URL for retrieving user profile data.

```http
POST https://api.hashpack.app/user-profile/get
```

--------------------------------

### POST https://api.hashpack.app/user-profile/get-multiple

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-multiple-profiles.md

Retrieves profile data for multiple specified account IDs.

```APIDOC
## POST https://api.hashpack.app/user-profile/get-multiple

### Description
This endpoint allows you to get a users profile for multiple account IDs.

### Method
POST

### Endpoint
https://api.hashpack.app/user-profile/get-multiple

### Request Body
- **accountIds** (array) - Required - List of account IDs to fetch profiles for.
- **network** (string) - Required - The network to query (e.g., "mainnet" or "testnet").

### Request Example
{
    "accountIds": ["0.0.1234", "0.0.12345"],
    "network": "mainnet"
}

### Response
#### Success Response (200)
- **Array** (object) - An array of profile data objects.

#### Response Example
[
    {
        "profilePicture": {
            "tokenId": "0.0.1234",
            "serial": 110,
            "thumbUrl": "https://hashpack.b-cdn.net/ipfs/Qmf8apzmTGrA5k2Y1DwBeUnpjEjUpRkcBpNx3ashKdp1ui?optimizer=image&width=350"
        },
        "theme": {
            "tokenId": "0.0.1234",
            "metadata": "ipfs://QmPcXnjJN7phcau2FJAFTXyRRAx43zrFmsW1cBLNjJuHdh",
            "themeId": "basic_early_supporter"
        },
        "username": {
            "name": "user.hbar",
            "tokenId": "0.0.1234",
            "serial": 141
        },
        "accountId": "0.0.1234",
        "network": "mainnet",
        "updatedAt": "2024-11-07T01:18:43.437Z",
        "nftFolders": [
            {
                "name": "My fav NFTs",
                "items": [
                    {
                        "tokenId": "0.0.1518294",
                        "serial": 63
                    }
                ]
            }
        ],
        "currency": "USD",
        "contacts": [
            {
                "name": "My Friend",
                "id": "0.0.1234",
                "note": "",
                "defaultMemo": ""
            }
        ],
        "bio": "Test bio",
        "twitterHandle": "username"
    }
]
```

--------------------------------

### POST https://api.hashpack.app/user-profile/get

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-single-profile.md

Retrieves the profile information for a specific user account on a given network.

```APIDOC
## POST https://api.hashpack.app/user-profile/get

### Description
This endpoint allows you to get a user's profile information by providing their account ID and the network they are on.

### Method
POST

### Endpoint
https://api.hashpack.app/user-profile/get

### Request Body
- **accountId** (string) - Required - The account ID of the user (e.g., "0.0.1234").
- **network** (string) - Required - The network to query, either "mainnet" or "testnet".

### Request Example
{
    "accountId": "0.0.1234",
    "network": "mainnet"
}

### Response
#### Success Response (200)
- **profilePicture** (object) - Contains tokenId, serial, and thumbUrl.
- **theme** (object) - Contains tokenId, metadata, and themeId.
- **username** (object) - Contains name, tokenId, and serial.
- **accountId** (string) - The account ID.
- **network** (string) - The network name.
- **updatedAt** (string) - ISO timestamp of the last update.
- **nftFolders** (array) - List of NFT folders.
- **currency** (string) - Preferred currency.
- **contacts** (array) - List of user contacts.
- **bio** (string) - User biography.
- **twitterHandle** (string) - User's Twitter handle.

#### Response Example
{
    "profilePicture": {
        "tokenId": "0.0.1234",
        "serial": 110,
        "thumbUrl": "https://hashpack.b-cdn.net/ipfs/Qmf8apzmTGrA5k2Y1DwBeUnpjEjUpRkcBpNx3ashKdp1ui?optimizer=image&width=350"
    },
    "theme": {
        "tokenId": "0.0.1234",
        "metadata": "ipfs://QmPcXnjJN7phcau2FJAFTXyRRAx43zrFmsW1cBLNjJuHdh",
        "themeId": "basic_early_supporter"
    },
    "username": {
        "name": "user.hbar",
        "tokenId": "0.0.1234",
        "serial": 141
    },
    "accountId": "0.0.1234",
    "network": "mainnet",
    "updatedAt": "2024-11-07T01:18:43.437Z",
    "nftFolders": [
        {
            "name": "My fav NFTs",
            "items": [
                {
                    "tokenId": "0.0.1518294",
                    "serial": 63
                }
            ]
        }
    ],
    "currency": "USD",
    "contacts": [
        {
            "name": "My Friend",
            "id": "0.0.1234",
            "note": "",
            "defaultMemo": ""
        }
    ],
    "bio": "Test bio",
    "twitterHandle": "username"
}
```

--------------------------------

### Response Data Format

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-multiple-profiles.md

The structure of the array returned by the API containing user profile details.

```json
[
    {
        "profilePicture": {
            "tokenId": "0.0.1234",
            "serial": 110,
            "thumbUrl": "https://hashpack.b-cdn.net/ipfs/Qmf8apzmTGrA5k2Y1DwBeUnpjEjUpRkcBpNx3ashKdp1ui?optimizer=image&width=350"
        },
        "theme": {
            "tokenId": "0.0.1234",
            "metadata": "ipfs://QmPcXnjJN7phcau2FJAFTXyRRAx43zrFmsW1cBLNjJuHdh",
            "themeId": "basic_early_supporter"
        },
        "username": {
            "name": "user.hbar",
            "tokenId": "0.0.1234",
            "serial": 141
        },
        "accountId": "0.0.1234",
        "network": "mainnet",
        "updatedAt": "2024-11-07T01:18:43.437Z",
        "nftFolders": [
            {
                "name": "My fav NFTs",
                "items": [
                    {
                        "tokenId": "0.0.1518294",
                        "serial": 63
                    }
                ]
            },
        ],
        "currency": "USD",
        "contacts": [
            {
                "name": "My Friend",
                "id": "0.0.1234",
                "note": "",
                "defaultMemo": ""
            },
        ],
        "bio": "Test bio",
        "twitterHandle": "username"
    }
]
```

--------------------------------

### Profile Response Object

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-single-profile.md

The structure of the JSON response returned by the profile API.

```json
{
    "profilePicture": {
        "tokenId": "0.0.1234",
        "serial": 110,
        "thumbUrl": "https://hashpack.b-cdn.net/ipfs/Qmf8apzmTGrA5k2Y1DwBeUnpjEjUpRkcBpNx3ashKdp1ui?optimizer=image&width=350"
    },
    "theme": {
        "tokenId": "0.0.1234",
        "metadata": "ipfs://QmPcXnjJN7phcau2FJAFTXyRRAx43zrFmsW1cBLNjJuHdh",
        "themeId": "basic_early_supporter"
    },
    "username": {
        "name": "user.hbar",
        "tokenId": "0.0.1234",
        "serial": 141
    },
    "accountId": "0.0.1234",
    "network": "mainnet",
    "updatedAt": "2024-11-07T01:18:43.437Z",
    "nftFolders": [
        {
            "name": "My fav NFTs",
            "items": [
                {
                    "tokenId": "0.0.1518294",
                    "serial": 63
                }
            ]
        },
    ],
    "currency": "USD",
    "contacts": [
        {
            "name": "My Friend",
            "id": "0.0.1234",
            "note": "",
            "defaultMemo": ""
        },
    ],
    "bio": "Test bio",
    "twitterHandle": "username"
}
```

--------------------------------

### Profile Request Payload

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-single-profile.md

The required JSON body for the profile retrieval request.

```json
{
    accountId: "0.0.1234",
    network: "mainnet" | "testnet"
}
```

--------------------------------

### Request Payload Structure

Source: https://docs.hashpack.app/dapp-developers/user-profiles/profile-api/get-multiple-profiles.md

The JSON body required for the POST request, specifying account IDs and the network.

```json
{
    accountIds: ["0.0.1234", "0.0.12345"],
    network: "mainnet" | "testnet"
}
```

--------------------------------

### Define NFT Metadata JSON Structure

Source: https://docs.hashpack.app/nft-creators/metadata-standards.md

This JSON schema represents the standard metadata format for NFTs on Hedera, including required fields like image and type, and optional file arrays.

```json
{
    "name": "NFT Name",
    "creator": "Creator Name",
    "description": "Human readable description of the asset - RECOMMENDED",
    "image": "cid or path to the NFT's image file, or for non-image NFTs, a preview image for display in wallets - REQUIRED",
    "type": "mime type - ie image/jpeg - REQUIRED",
    "files": [ // object array that contains uri, type and metadata - can contain multiple files
        {
            "uri": "cid or uri to file - REQUIRED",
            "is_default_file": "(Type: boolean) indicates if the file is the main file for this NFT - OPTIONAL",
            "type": "mime type - REQUIRED"
        }
    ],
    "properties": {
        // arbitrary json objects that cover the overarching properties of the token
    }
}
```
Tokens:
Raw