Coins SDK

The @zoralabs/coins-sdk package allows developers to interact with the ZORA coins protocol.

This SDK is based off of viem v2 and exposes both functions to get the viem call to use with WAGMI, and also functions that complete the actions using the simulateContract and writeContract calls. Many reasonable defaults are set for fields, so read the action files and types to determine which parameters are needed for your actions.

Devs can input their addresses in platformReferrer and traderReferrer fields to earn trade and create referral fees for their platform.

This SDK has two main categories of functionality: Onchain Actions and Offchain Queries.

All the SDK functions are accessible from the main export (for example: import {createCoin, getCoin} from "@zoralabs/coins-sdk").

All documentation for coins is available on docs.zora.co.

Contact us at x.com/zoradevs warpcast/~/channel/zora-devs.

Docs links

Onchain Actions

• createCoin
• tradeCoin
• updateCoinURI
• updatePayoutRecipient

Queries

• Onchain queries
  • getOnchainCoinDetails
• API Queries
  • API Key
  • Cursor Pagination
  • Queries
    • Coin queries
    • Profile queries
    • Explore queries

getProfileSocial

The getProfileSocial helper in src/api/queries.ts wraps the /profileSocial API query and returns the enriched social metadata for a profile (social handles + follower counts, creator coin details, linked wallets, and the social account linking history).

import { getProfileSocial } from "@zoralabs/coins-sdk";

const profileSocial = await getProfileSocial({
  query: {
    // Same identifier that other profile endpoints expect
    identifier: "zoradev",
  },
});

const farcasterHandle = profileSocial.data.profile?.socialAccounts?.farcaster?.username;

• identifier is required and accepts any identifier supported by the other profile queries (Zora username/handle, wallet address, or profile ID).
• A successful response includes the profile's socialAccounts (Instagram, TikTok, Twitter, Farcaster), linkedWallets, followers / following counts, optional creatorCoin metrics, and a socialAccountLinkedEvents edge list that records when social accounts were linked or unlinked.
• The request requires the standard Coins API key metadata—if you are already using getApiKeyMeta (as shown in other queries) no additional configuration is necessary.