Overview

Profiles record the basic information of accounts, including the name, avatar, bio, connected accounts, etc.

API

Get

const profiles: Profiles = await unidata.profiles.get(options: {
    source: string;
    identity: string;
    platform?: string;
    limit?: number;
    cursor?: any;
    filter?: any;
});

• identity: Ethereum address, Solana address, Flow address, Crossbell handle, etc.
• platform: Platfrom of the identity. Ethereum, Solana, Flow, Crossbell, etc. Default to Ethereum.
• limit: The number of assets to return. Since providers use different pagination schemes, there is no guarantee that the quantities are always accurate.
• cursor: The pagination cursor returned from the previous page's results. Since providers use different pagination schemes, the type is uncertain.

Set

Add or update your profiles.

const result: {
    code: number;
    message: string;
} = await unidata.profiles.set(
    options: {
        source: string;
        identity: string;
        platform?: string;
        action?: string;
    },
    input: {
        username?: string;
        name?: string;
        avatars?: URI[];
        bio?: string;
        websites?: URI[];
        banners?: {
            address: URI;
            mime_type: string;
        }[];
        connected_accounts?: {
            identity: string;
            platform: string;
            url?: string;
        }[];
    }
);

Specification

All returned data conform to the following specification.

type Profiles = {
    total: number;

    list: {
        username?: string;
        name?: string;
        avatars?: URI[];
        bio?: string;
        websites?: URI[];
        banners?: {
            address: URI;
            mime_type: string;
        }[];

        connected_accounts?: {
            identity: string;
            platform: string;
            url?: string;
        }[];

        source: ProfileSource;

        metadata?: {
            network: Network;
            proof: string;

            [key: string]: any;
        };
    }[];
};