NFT API
Introduction to FabricBloc NFT Microservice
Welcome to the FabricBloc NFT Microservice documentation! This project provides a robust, extensible backend for managing NFT (Non-Fungible Token) collections, minting, metadata, and smart contract deployment. It is designed for both rapid development and production-ready deployments.
What is FabricBloc NFT Microservice?
FabricBloc NFT Microservice is a backend service that exposes RESTful APIs to:
Create and manage NFT collections
Mint and burn NFTs
Store and retrieve NFT metadata (handled internally)
Deploy, estimate, and verify smart contracts (ERC-721) (verification is under development)
Monitor service and database health
It is suitable for developers, integrators, and organizations building NFT platforms, marketplaces, or tools.
Key Features
FabricBloc NFT Microservice is designed for modern NFT platforms, offering a rich set of features for developers and organizations seeking flexibility, security, and scalability.
Multiple NFT Standards & Networks
ERC-721 & ERC-1155 Support: Flexible contract types for diverse NFT needs (ERC-1155 planned).
Multi-Chain Ready: Ethereum supported, Polygon coming soon.
Collection & Asset Management
Full Lifecycle Operations: Create, update, delete, and list NFT collections and assets. (Planned)
Metadata Management: Attach, retrieve, and manage rich metadata for every NFT. (Handled internally)
Customizable Storage: Store metadata via API or IPFS (on-chain support planned).
Royalty & Minting Controls: Public/private minting, royalties, and advanced controls (planned).
Secure Minting & Transfers
Mint & Burn: Issue and destroy NFTs securely.
Transfer Support: Transfer NFTs between users with auditability
Smart Contract Automation
Automated Deployment: Deploy ERC-721 contracts with a single API call.
Cost Estimation: Get real-time deployment cost estimates.
Verification Tools: Verify contract status and integrity. (Planned)
Robust Security & Compliance
JWT Authentication: Secure endpoints with token-based auth (integration ready).
Input Validation: Strict validation and sanitization for all API requests.
Rate Limiting: Protection against abuse and brute-force attacks.
CORS & API Security: Configurable CORS and security headers.
Developer Experience
Comprehensive API Docs: Interactive Swagger/OpenAPI documentation.
Health Monitoring: Built-in health endpoints for service and database.
Notifications & Integrations
Webhook/Callback Ready: Event-based notifications for integration with external systems. (Planned)
Current Modules & Features
User & Access Management
User Ownership: Each NFT collection is associated with a user (wallet address support planned).
Authentication Ready: Endpoints designed for JWT-based authentication (integration ready).
NFT Collection Management
Create, update, delete, and list NFT collections
Support for ERC-721 (live), ERC-1155 (planned)
Multi-network architecture (Ethereum live, Polygon planned)
Metadata and royalty support
NFT Minting & Burning
Mint new NFTs to collections
Burn NFTs
Transfer NFTs between users
Public/private minting controls (public minting coming soon)
Metadata Service
Attach and retrieve arbitrary JSON metadata (handled internally)
Support for API and IPFS storage (on-chain planned)
Smart Contract Deployment
Deploy ERC-721 contracts via API
Estimate deployment costs
Contract verification (Planned)
Security & Monitoring
Rate limiting, input validation, and CORS configuration (Planned)
Health check endpoints for service and database (Planned)
Services Overview
Current Version
Version: 0.1.0
Status: Development Ready
Last Updated: July 2025
Base URLs
Production: https://api.dev.fabricbloc.com/
API Base: https://api.dev.fabricbloc.com/v1/nft
API Documentation: https://api.dev.fabricbloc.com/v1/nft/swagger/index.html
1. NFT Collection Management
Create, list, update, and delete NFT collections
Each collection is associated with a user and supports metadata
Supports ERC-721 and ERC-1155 contract types (ERC-1155 - not implemented yet)
Supports ethereum and polygon networks (polygon - not implemented yet)
Supports IPFS and api storage methods (onchain - future support)
Supports public and private minting (public minting - not implemented yet)
Supports royalty (royalty - not implemented yet)
2. NFT Minting & Burning
Mint new NFTs to a collection
Burn (destroy) NFTs
Transfer NFTs between owners
3. Metadata Service
Attach arbitrary JSON metadata to NFTs
Retrieve metadata by collection and NFT ID
4. Smart Contract Deployment
Deploy ERC-721 contracts to Ethereum testnet
Estimate deployment costs
Verify contract status (not implemented yet)
5. Health Check
/v1/nft/healthendpoint for service and database status
Note: For deploy, mint, and similar calls, the API response only indicates that the transaction has been initiated. Please check the transaction (hash) status and details directly on-chain (e.g., for Ethereum Sepolia, visit sepolia.etherscan.io).
NFT Collection Lifecycle
This project models the full lifecycle of an NFT collection — from creation to minting, transfer, and burn.
Note: This diagram represents the planned workflow. Some features (like pausing contracts, royalities etc...) are under active development and may not be fully implemented yet.
Last updated
Was this helpful?