Public API

Here, you'll find everything you need to know about accessing and interacting with our Public API endpoints. Our API allows you to seamlessly integrate our services into your applications. Below is an overview of the key endpoints available to you, along with detailed descriptions and usage instructions.

Base URL

Base URL for all endpoints listed on this page

https://mainnet.api.perawallet.app/v1/public/

Swagger

Pera Wallet API

Pera Wallet Public API Swagger

Verified Asset List

get

This is a simplified endpoint that returns all verified assets in a single response. The endpoint returns verified assets with asset verification label by excluding suspicious and unverified ones. If your business logic needs to know the verified asset ids, this is the endpoint you should use. It is lightweight and doesn't require pagination.

• Response is cached for 5 min.

Query parameters

orderingstringOptional

Which field to use when ordering the results.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/public/verified-assets/ HTTP/1.1
Host: mainnet.api.perawallet.app
Accept: */*

200Success

[
  {
    "asset_id": 1,
    "verification_tier": "trusted"
  }
]

Labeled Asset List

get

This is a simplified endpoint that returns all labeled assets in a single response. The endpoint returns verified and suspicious assets with asset verification label by excluding unverified ones. If your business logic needs to know the labeled asset ids, this is the endpoint you should use. It is lightweight and doesn't require pagination.

• Response is cached for 5 min.

Query parameters

orderingstringOptional

Which field to use when ordering the results.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/public/labeled-assets/ HTTP/1.1
Host: mainnet.api.perawallet.app
Accept: */*

200Success

[
  {
    "asset_id": 1,
    "verification_tier": "trusted"
  }
]

Asset List

get

This public endpoint returns all assets.

• Response is cached for 5 min.
• Maximum page size: 1000
• Default page size: 50
• Page size options: 50, 100, 500, 1000

Query parameters

filterstringOptional

['is_verified', 'is_collectible']

orderingstringOptional

Which field to use when ordering the results.

cursorstringOptional

The pagination cursor value.

limitintegerOptional

Number of results to return per page.

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/public/assets/ HTTP/1.1
Host: mainnet.api.perawallet.app
Accept: */*

200Success

{
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "asset_id": 1,
      "name": "text",
      "unit_name": "text",
      "fraction_decimals": 1,
      "total_supply": 1,
      "is_deleted": "text",
      "creator_address": "text",
      "url": "text",
      "logo": "https://example.com",
      "verification_tier": "trusted",
      "usd_value": "text",
      "is_collectible": true
    }
  ]
}

Asset Verification Detail

get

This public endpoint returns Asset verification information about a specific ASA on the Algorand blockchain. This is the recommended public API for fetching the verification status of an ASA from Pera. More details about the verification program can be found here: https://explorer.perawallet.app/asa-verification/

Path parameters

asset_idanyRequired

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/public/asset-verifications/{asset_id}/ HTTP/1.1
Host: mainnet.api.perawallet.app
Accept: */*

200Success

{
  "asset_id": 1,
  "verification_tier": "trusted",
  "explorer_url": "https://example.com"
}

Asset Detail

get

This public endpoint returns details of an asset.

• Response is cached for 5 min.

Path parameters

asset_idanyRequired

Query parameters

include_collectiblebooleanOptional

Responses

200Success

application/json

get

HTTPcURLJavaScriptPython

GET /v1/public/assets/{asset_id}/ HTTP/1.1
Host: mainnet.api.perawallet.app
Accept: */*

200Success

{
  "asset_id": 1,
  "name": "text",
  "unit_name": "text",
  "fraction_decimals": 1,
  "total_supply": 1,
  "is_deleted": "text",
  "creator_address": "text",
  "url": "text",
  "logo": "https://example.com",
  "verification_tier": "trusted",
  "usd_value": "text",
  "is_collectible": true,
  "verification_details": {
    "project_name": "text",
    "project_url": "https://example.com",
    "project_description": "text",
    "discord_url": "https://example.com",
    "telegram_url": "https://example.com",
    "twitter_username": "text"
  },
  "collectible": {
    "title": "text",
    "description": "text",
    "standards": [
      "text"
    ],
    "thumbnail_url": "https://example.com",
    "thumbnail_ipfs_cid": "text",
    "media": [
      {
        "type": "image",
        "url": "text",
        "ipfs_cid": "text",
        "extension": "text"
      }
    ],
    "metadata": {},
    "traits": [
      {
        "display_name": "text",
        "display_value": "text"
      }
    ]
  }
}

Usage Requirements

To use Pera Wallet Public API you must comply with the following requirements:

• Please note “Data provided by Pera“ & display the Pera logo

• Display the Pera Verified and Suspicious badges next to each ASA

• Link to the ASA's Pera Explorer page, with the Pera logo and "View on Pera Explorer" call to action clearly visible.

All brand assets are available at our media kit.

Deprecation Notice

As part of this expansion, we are restructuring our existing public endpoints. The current v1/ endpoints will be moved to the v1/public/ path.

There will not be any change in the response format of these APIs, but the requests will be redirected to the new path starting August 1st 2024. It is important for users to migrate their projects to the new path to ensure faster access to the API.