Matrica
  • Matrica
  • Guides
    • Pricing Guide
    • User Guide
      • Getting Started
      • Linking Wallets
      • Linking Socials
      • Customizing Your Profile
      • Bot Commands
      • Privacy Settings
      • /flash
    • Community Guide
      • Getting Started
      • Manage Community
      • Manage Collections
      • Discord Set-Up
        • Invite the Bot
        • Bot commands
        • Snapshots
      • Verification
        • Adding Rules
        • Fungible Token Roles
        • Amount Based Roles
        • Attribute Based Roles
        • Logic Operators
        • Status Based Roles
        • Verified Collection Roles
        • X Username Gating
        • Wallet Address Gating
        • Validator Stake Gating
        • Inscription # Based Roles
        • Royalty Based Roles
      • Telegram Set-Up
        • Invite the Bot
        • Bot Commands
        • Add Requirements
        • Invite Links
      • Sales Bot and Web-hooks
        • Discord Sales and Listings
        • Telegram Sales
      • Events
        • Create Event
        • Location
        • Requirements
        • Ticketing
      • Proposals
      • Customer Support
      • Staking Support
      • Add-Ons
    • Enterprise
  • Matrica Connect
    • Matrica Connect Overview
    • Who's Building with Matrica Connect?
    • What is OAuth2?
    • Create your application
    • Initial Redirect
    • Retrieving the Access Token
    • API Reference
  • API Reference
    • API - Getting Started
    • Feed
    • User
    • Wallet
    • Events
    • NFT
    • Snapshot
    • Onboard
    • Search
    • Collection
Powered by GitBook
On this page
  1. API Reference

User

/v1/user

PreviousFeedNextWallet

Last updated 7 months ago

Get user

Returns a Matrica user by their username.

Returns a Matrica user's profile.

Get NFT Collection Counts for a User

Returns the count of NFTs a user owns in specific collections. This route is Enterprise only.

Find a user by username.

get
Path parameters
usernamestring · min: 1Required
Query parameters
apiKeystring · min: 4Required
Responses
200
Returns the user.
400
Bad request.
404
User not found.
get
GET /v1/user/{username} HTTP/1.1
Host: api.matrica.io
Accept: */*

No content

Get NFT collection counts for a user.

get
Path parameters
userIdstringRequired

The ID of the user whose NFT collections are to be retrieved.

Query parameters
collectionIdstringOptional

Optional filter to retrieve NFTs for a specific collection.

Responses
200
Returns the NFT collection counts for the user.
application/json
400
Invalid user ID or user not found.
application/json
get
GET /v1/user/{userId}/nft-collections HTTP/1.1
Host: 
Accept: */*
[
  {
    "collectionId": "3469c345-04db-4d19-b207-7fa1138dd940",
    "collectionName": "Matrica Pixels",
    "count": 5
  },
  {
    "collectionId": "e11bbb2a-a8e7-4a79-b9e4-32e8f34749dd",
    "collectionName": "Matrica Blocks",
    "count": 8
  }
]

Get user PFP.

get
Path parameters
userIdstringRequired

The ID of the user

Responses
200
Returns the user PFP.
application/json
get
GET /v1/user/{userId}/pfp HTTP/1.1
Host: api.matrica.io
Accept: */*
200

Returns the user PFP.

{
  "collectionName": "Bored Ape Yacht Club",
  "collectionPfp": "https://example.com/collection-pfp.jpg",
  "pfpNFTId": "123",
  "pfpNFTUrl": "https://example.com/nft-image.jpg"
}
  • Get user
  • GETFind a user by username.
  • Get NFT Collection Counts for a User
  • GETGet NFT collection counts for a user.
  • GETGet user PFP.