API
Trending Arts
Fetches a list of currently trending artworks on the Phi.Box platform, including metadata like title, image, artist info, and minting URL.
Endpoint
Response Format
Returns a JSON array of trending artworks with the following fields:
Field Descriptions
key
string
Unique identifier composed of credChainId and artId.
url
string
Direct URL to mint or view the artwork.
credChainId
string
Chain ID associated with the credential.
credId
string
Credential ID indicating the collection or origin.
artChainId
string
Chain ID of the artwork.
artId
string
Unique identifier of the artwork.
name
string
Title of the artwork.
image
string
Arweave-hosted image URL for the artwork.
artist
string
Ethereum address of the artist.
artistENSName
string/null
ENS name of the artist if available.
project
string
Project or collection name. Usually "Base".
Example Request
Example Response
Notes
ENS names may be null if not set by the artist.
All images are hosted on Arweave, ensuring permanence.
The key can be used as a unique identifier in frontend components or UI render loops.
PHI Trusted Artists
Returns a list of Ethereum addresses of artists who are trusted by the PHI community. These addresses represent verified or curated creators whose artworks are eligible for specific features or recognition within the platform.
Endpoint
Response Format
Example Request
Example Response
Notes
This list can be used for filtering, verification, or giving special status to artworks from verified creators.
The order of addresses is not guaranteed to be meaningful (i.e., not sorted by activity or reputation).
You can cross-reference these addresses with artwork metadata to verify the artist’s PHI-trusted status.
Pin Image
Fetches the currently pinned artwork(s) for a given wallet address on the PHI platform.
Endpoint
Example Request
Example Response
Minter List (Art)
Fetches the list of wallet addresses that minted a specific artwork (token) from a given contract on the PHI platform.
Endpoint
Query Parameters
limit
number
Optional
Number of entries to return (default varies, max recommended 100).
Example Request:
Response Format
Returns a JSON array of wallet addresses that minted the specified token:
Notes
contract_address must be in the format: base:0x... (including the prefix for L2 chains like Base).
Commonly used in analytics, community insights, or airdrop planning.
No pagination yet, but use limit to restrict data size for performance.
Credentials List
Returns a list of all available creds. Each cred includes its title, eligibility requirement, type, verification method, creator address, and other associated metadata.
Example Request
Example Response
Use Case
Display available creds
Allow users to browse drops they may be eligible for
Enable developers to query and filter based on cred_type, tags, or related projects
Art List
This endpoint retrieves a list of art records related to a specified chain. Each art record contains various metadata, such as details about the artist, the associated credential, and the associated images. This endpoint is primarily used to fetch art data stored on the system.
End Point
Query Parameters
limit (optional): Specifies the maximum number of art records to return in the response. Default is typically 100 if not specified.
Example: limit=2 will return only 2 records.
Response Structure
The response will be a JSON object containing the following properties:
total: The total number of art records available.
records: An array of art records, where each record contains the metadata for an individual art piece.
Example Response
Eligibility Check
This API checks the eligibility of a given wallet address for minting specific creds or participating in trending art campaigns. The request can be made to check either "trending" art or specific creds based on the provided parameters. The system supports rate limiting, authentication via API key, and error handling for both invalid requests and service disruptions.
Query Parameter
type: (Required) The type of eligibility check. Options: "trending": Check eligibility for trending art. "specific": Check eligibility for specific creds. address: (Required) The wallet address to check eligibility for (in hex format). referrer: (Optional) The referrer’s wallet address (in hex format). If provided, referrers earn 0.00005 ETH per mint. specificCreds: (Optional) Only required if type is "specific". This is an array of specific creds to check. Each item should have the following format: credChainId: The chain ID where the cred exists. credId: The ID of the specific cred.
Response Structure
The response will include eligibility results based on the provided type. It will return a JSON object with keys for each item being checked, indicating whether the address is eligible and providing additional details like a URL for minting (if applicable).
Response for Trending Art:
Response for Specific Cred:
eligible: Boolean value indicating whether the address is eligible to mint.
url (optional): If the check type is "trending", the URL for minting will be included. If the referrer is provided, it will be appended to the URL.
Rate Limiting
The API enforces rate limiting to ensure fair usage. You can make up to 5 requests per second. If this limit is exceeded, the system will respond with a 429 status and suggest trying again after a short delay.
Eligible List
Returns a list of all currently eligible trending artworks for a given wallet acting as a referrer. This API helps track which trending art pieces can be minted using a particular referrer link (i.e., those the wallet is eligible for).
Endpoint
Query Parameters
referrer
string (hex address)
Yes
Wallet address (in hex format) for which to fetch eligible artworks
Example Request
Response Format
Use Case
Tracking Referrer Mints: Helps referrers know which artworks they are eligible to promote and earn referral rewards for.
Eligibility-based UI: Enables wallets to show users personalized mintable content based on referrer eligibility.
Last updated