### GET /api/v1/nft/categories/all Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-all-nft-categories Retrieves a list of all available NFT categories from the Hybrid-Chain API. ```APIDOC ## GET /api/v1/nft/categories/all ### Description Retrieves a list of all available NFT categories. ### Method GET ### Endpoint /api/v1/nft/categories/all ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(object)** - An object containing NFT category data. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### NFT: Get Created NFT Tags Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-created-nft-tags Retrieves a list of all created NFT tags. ```APIDOC ## GET /api/v1/nft/tags/all ### Description Retrieves a list of all created NFT tags. ### Method GET ### Endpoint /api/v1/nft/tags/all ### Parameters #### Query Parameters (No query parameters for this endpoint) #### Request Body (No request body for this endpoint) ### Request Example (No request body example) ### Response #### Success Response (200) - **tags** (array) - A list of created NFT tags. #### Response Example ```json { "tags": [ "tag1", "tag2", "tag3" ] } ``` ``` -------------------------------- ### MTF: Get MTF Markets Source: https://dev.hybrid-chain.com/api-docs/decentralized-trading/dex-get-dex-markets Retrieves an overview of all available markets on the Decentralized Exchange for Margin Trading. ```APIDOC ## GET /api/v1/mtf/markets ### Description Returns an overview of all available markets on the Decentralized Exchange. ### Method GET ### Endpoint /api/v1/mtf/markets ### Parameters #### Query Parameters None #### Path Parameters None ### Request Body None ### Request Example None ### Response #### Success Response (200) - **Server** (string) - The server handling the request. - **Date** (string) - The date and time of the response. - **Content-Type** (string) - The MIME type of the response body. - **Content-Length** (integer) - The size of the response body in bytes. - **Cache-Control** (string) - Caching directives for the response. - **Connection** (string) - The type of connection. - **keep-alive** (string) - Keep-alive connection information. - **Access-Control-Allow-Origin** (string) - CORS policy for the response. - **Set-Cookie** (string) - Cookies to be set by the client. - **Vary** (string) - Indicates the request headers that affect the response. - **Content-Encoding** (string) - The encoding of the response body. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### POST /api/v1/quantum/storage/newfolder Source: https://dev.hybrid-chain.com/api-docs/storage-and-data-transfer/distributed-storage/storage-create-folder Creates a new folder within the Quantum Storage service. ```APIDOC ## POST /api/v1/quantum/storage/newfolder ### Description Creates a new folder within the Quantum Storage service. ### Method POST ### Endpoint /api/v1/quantum/storage/newfolder ### Parameters #### Query Parameters None #### Request Body - **(object)** - Required - The request body is an empty JSON object for this operation. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **(object)** - Description of the success response body (details not provided in the schema). #### Response Example ```json {} ``` ``` -------------------------------- ### GET /api/v1/mtf/market_chart Source: https://dev.hybrid-chain.com/api-docs/perpetuals-trading/mtf-get-mtf-candle-data Retrieves MTF candle data for a given market and timeframe. You can specify the start and end timestamps for the data retrieval. ```APIDOC ## GET /api/v1/mtf/market_chart ### Description Returns chart-data for the indicated market in various timeframes ('minute', 'hour', 'day'). ### Method GET ### Endpoint /api/v1/mtf/market_chart ### Parameters #### Query Parameters - **interval** (string) - Required - The timeframe for the candle data (e.g., 'minute', 'hour', 'day'). - **market** (string) - Required - The market identifier for which to retrieve data. - **from** (integer) - Optional - The starting timestamp (Unix epoch time) for the data retrieval. - **to** (integer) - Optional - The ending timestamp (Unix epoch time) for the data retrieval. ### Request Example ```json { "example": "GET /api/v1/mtf/market_chart?market=BTC-PERPETUAL&interval=hour&from=1678886400&to=1678972800" } ``` ### Response #### Success Response (200) - **(No specific fields documented in the provided OpenAPI spec, but typically includes an array of candle data objects)** #### Response Example ```json { "example": "[\n {\n \"timestamp\": 1678886400,\n \"open\": 25000.00,\n \"high\": 25100.00,\n \"low\": 24900.00,\n \"close\": 25050.00,\n \"volume\": 1000.00\n },\n {\n \"timestamp\": 1678890000,\n \"open\": 25050.00,\n \"high\": 25200.00,\n \"low\": 25000.00,\n \"close\": 25150.00,\n \"volume\": 1200.00\n }\n]" } ``` ``` -------------------------------- ### Get All Transactions (OpenAPI 3.0) Source: https://dev.hybrid-chain.com/api-docs/core-functionality/vault-wallet-functions/wallet-get-all-transactions This OpenAPI 3.0 specification defines the 'Get All Transactions' endpoint for the Hybrid-Chain API. It outlines the GET request for the '/wallet/transactions' path, detailing the response structure for a successful retrieval of user transactions. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/wallet/transactions": { "get": { "tags": [ "Vault / Wallet Functions" ], "summary": "WALLET: Get All Transactions", "description": "This Endpoint returns a list of all transactions made by the user (includes deposits, conversions, withdrawals, etc.).\n\nIt's much more lightweight than pulling the entire profile of a user for the same data.", "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Connection": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } }, "Content-Encoding": { "schema": { "type": "string" } }, "Strict-Transport-Security": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### POST /api/v1/quantum/storage/download Source: https://dev.hybrid-chain.com/api-docs/storage-and-data-transfer/distributed-storage/storage-view-download-file This endpoint allows you to create a file download link from DataVault. It is part of the Quantum Storage API. ```APIDOC ## POST /api/v1/quantum/storage/download ### Description Creates a file download link from DataVault. ### Method POST ### Endpoint /api/v1/quantum/storage/download ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **(object)** - Required - The request body is an empty JSON object. ### Request Example ```json {} ``` ### Response #### Success Response (200) - **Server** (string) - Description of the Server header. - **Date** (string) - Description of the Date header. - **Content-Type** (string) - Description of the Content-Type header. - **Content-Length** (integer) - Description of the Content-Length header. - **Connection** (string) - Description of the Connection header. - **Cache-Control** (string) - Description of the Cache-Control header. - **Access-Control-Allow-Origin** (string) - Description of the Access-Control-Allow-Origin header. - **Set-Cookie** (string) - Description of the Set-Cookie header. - **Vary** (string) - Description of the Vary header. - **(object)** - The response body is an empty JSON object. #### Response Example ```json {} ``` ``` -------------------------------- ### Get All NFT Tags (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-created-nft-tags This snippet defines the OpenAPI 3.0 specification for the 'NFT: Get Created NFT Tags' endpoint. It outlines the HTTP GET method, the request path, and the expected successful response structure. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/api/v1/nft/tags/all": { "get": { "tags": [ "NFT Super Store" ], "summary": "NFT: Get Created NFT Tags", "responses": { "200": { "description": "Successful response", "content": { "application/json": {} } } } } } } } ``` -------------------------------- ### Create Folder API Endpoint (OpenAPI Specification) Source: https://dev.hybrid-chain.com/api-docs/storage-and-data-transfer/distributed-storage/storage-create-folder This snippet defines the OpenAPI 3.0 specification for the POST /api/v1/quantum/storage/newfolder endpoint. It outlines the request method, tags, summary, request body schema, and successful response details, including common HTTP headers. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/api/v1/quantum/storage/newfolder": { "post": { "tags": [ "Quantum Storage" ], "summary": "STORAGE: Create New Folder", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Connection": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Set-Cookie": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### STORAGE: Create File Download Link (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/storage-and-data-transfer/distributed-storage/storage-view-download-file This snippet defines the OpenAPI 3.0 specification for the POST /api/v1/quantum/storage/download endpoint. It details the request body, expected responses, and security requirements for creating a file download link from DataVault. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/api/v1/quantum/storage/download": { "post": { "tags": [ "Quantum Storage" ], "summary": "STORAGE: Create File Download Link from DataVault", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Connection": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Set-Cookie": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### NFT: Get Collection Meta-Data API Specification (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-collection-meta-data This snippet defines the OpenAPI 3.0 specification for the NFT: Get Collection Meta-Data API endpoint. It outlines the GET request, query parameters, and the structure of the successful response. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "noauthAuth": [] } ], "components": { "securitySchemes": {} }, "paths": { "/api/v1/nft/collections/meta": { "get": { "tags": [ "NFT Super Store" ], "summary": "NFT: Get Collection Meta Data", "parameters": [ { "name": "collection_uuid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Cache-Control": { "schema": { "type": "string" } }, "Connection": { "schema": { "type": "string" } }, "keep-alive": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } }, "Content-Encoding": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### Get NFT Meta-Data API Specification (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-nft-meta-data This snippet defines the OpenAPI 3.0 specification for the NFT: Get NFT Meta Data endpoint. It outlines the HTTP GET request, query parameters, and expected JSON response structure for retrieving NFT metadata. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "noauthAuth": [] } ], "components": { "securitySchemes": {} }, "paths": { "/api/v1/nft/tokens/meta": { "get": { "tags": [ "NFT Super Store" ], "summary": "NFT: Get NFT Meta Data", "parameters": [ { "name": "token_uuid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Cache-Control": { "schema": { "type": "string" } }, "Connection": { "schema": { "type": "string" } }, "keep-alive": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } }, "Content-Encoding": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### TOKENS: Get all Equity Tokens Source: https://dev.hybrid-chain.com/api-docs/tokenized-equities/tokens-get-all-equity-tokens Retrieves an overview of all available markets on the Decentralized Exchange. ```APIDOC ## GET /api/v1/tokens/available ### Description Returns an overview of all available markets on the Decentralized Exchange. ### Method GET ### Endpoint /api/v1/tokens/available ### Parameters #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(object)** - Successful response #### Response Example ```json {} ``` ``` -------------------------------- ### POST /api/v1/nft/tokens/buy-nft Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-instant-buy-nft Initiates an instant purchase for an NFT. This endpoint is part of the NFT Super Store functionality. ```APIDOC ## POST /api/v1/nft/tokens/buy-nft ### Description Initiates an instant purchase for an NFT. This endpoint is part of the NFT Super Store functionality. ### Method POST ### Endpoint /api/v1/nft/tokens/buy-nft ### Parameters #### Query Parameters None #### Request Body - **(object)** - Required - The schema for the request body is not specified in detail, but it is expected to contain information necessary for the NFT purchase. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **(object)** - Successful response. The specific fields are not detailed. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Referral Data API Specification (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/core-functionality/user-profile-data/profile-get-referral-data This OpenAPI 3.0 specification defines the GET /profile/referral_data endpoint. It outlines the request method, response structure, security requirements (JWT Bearer Token), and server URL. No specific request body is defined for this GET request. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/profile/referral_data": { "get": { "tags": [ "User Profile Data" ], "summary": "PROFILE: Get Referral Data", "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Cache-Control": { "schema": { "type": "string" } }, "Connection": { "schema": { "type": "string" } }, "keep-alive": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### Invite New User - POST /api/v1/network/invite Source: https://dev.hybrid-chain.com/api-docs/peripheral-functions/referral-system/network-invite-a-new-user This endpoint allows for inviting or referring a new user to the network. It expects a POST request to the /api/v1/network/invite path. The request body should be a JSON object, and a successful response will return a 200 OK status with a JSON object. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/api/v1/network/invite": { "post": { "tags": [ "Referral System" ], "summary": "NETWORK: Invite/Refer a new User", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Cache-Control": { "schema": { "type": "string" } }, "Connection": { "schema": { "type": "string" } }, "keep-alive": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### Get Referral Key - OpenAPI Specification Source: https://dev.hybrid-chain.com/api-docs/peripheral-functions/referral-system/network-get-referral-key This OpenAPI 3.0 specification defines the 'NETWORK: Get Referral Key' GET endpoint. It outlines the request method, path, tags, summary, description, and expected responses, including headers and content type for a successful retrieval. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/api/v1/network/refkey": { "get": { "tags": [ "Referral System" ], "summary": "NETWORK: Get Referral Key", "description": "This Endpoint returns the Referral Key of the user, which can be used to generate links (via emailing, etc.) or to register other users in the AUTH: Register a User Endpoint.", "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Cache-Control": { "schema": { "type": "string" } }, "Connection": { "schema": { "type": "string" } }, "keep-alive": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### NFT: Get NFT Lifecycle History API (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-nft-lifecycle-history This OpenAPI 3.0 specification defines the 'NFT: Get NFT Lifecycle History' endpoint. It outlines the request method (GET), parameters (token_uuid), and expected responses, including success (200 OK) and potential error structures. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "noauthAuth": [] } ], "components": { "securitySchemes": {} }, "paths": { "/api/v1/nft/tokens/history": { "get": { "tags": [ "NFT Super Store" ], "summary": "NFT: Get NFT Lifecycle History", "parameters": [ { "name": "token_uuid", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Cache-Control": { "schema": { "type": "string" } }, "Connection": { "schema": { "type": "string" } }, "keep-alive": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } }, "Content-Encoding": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### POST /api/v1/nft/tokens/new Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-create-new-nft Creates a new NFT token. This endpoint allows for the creation of new non-fungible tokens within the Hybrid-Chain ecosystem. ```APIDOC ## POST /api/v1/nft/tokens/new ### Description Creates a new NFT token. This endpoint allows for the creation of new non-fungible tokens within the Hybrid-Chain ecosystem. ### Method POST ### Endpoint /api/v1/nft/tokens/new ### Parameters #### Query Parameters None #### Request Body - **(object)** - Required - The schema for the request body is not specified in the provided documentation, but it is expected to contain the necessary information to create a new NFT. ### Request Example ```json { "example": "request body" } ``` ### Response #### Success Response (200) - **(object)** - Description: Successful response. The specific structure of the success response is not detailed in the provided documentation. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Tokenization & NFT Launch API Source: https://dev.hybrid-chain.com/api-docs/index Tokenize real-world assets, equities, claims, NFTs, or financial derivatives using the built-in tokenization engine. Launch ICO/NFT campaigns. ```APIDOC ## Tokenization & NFT Launch API ### Description This API allows for the creation and management of digital tokens representing real-world assets or digital collectibles. It includes functionalities for tokenizing various asset types, launching Initial Coin Offerings (ICOs), and managing Non-Fungible Token (NFT) campaigns. ### Method POST, PUT, GET ### Endpoint /api/v1/tokenize/asset /api/v1/ico/launch /api/v1/nft/campaign ### Parameters #### Path Parameters None for these primary endpoints. #### Query Parameters - **status** (string) - Optional - Filter tokenization or campaign status (e.g., 'draft', 'active', 'completed'). - **assetType** (string) - Optional - Filter by the type of asset being tokenized (e.g., 'real_estate', 'equity', 'nft'). #### Request Body - **assetDetails** (object) - Required - Information about the asset to be tokenized. - **name** (string) - Required - Name of the asset. - **description** (string) - Optional - Detailed description of the asset. - **type** (string) - Required - Type of asset (e.g., 'real_estate', 'equity', 'nft'). - **underlyingValue** (number) - Optional - The quantifiable value of the underlying asset. - **tokenDetails** (object) - Required - Specifications for the digital token. - **symbol** (string) - Required - The unique symbol for the token (e.g., 'REAI', 'NFTX'). - **supply** (number) - Required - The total supply of the token. - **decimals** (integer) - Optional - Number of decimal places for the token. - **campaignDetails** (object) - Optional - Details for launching an ICO or NFT campaign. - **startDate** (string) - Required - Campaign start date (ISO 8601 format). - **endDate** (string) - Required - Campaign end date (ISO 8601 format). - **goalAmount** (number) - Optional - Fundraising goal for the campaign. ### Request Example ```json { "assetDetails": { "name": "Luxury Apartment Unit 5B", "type": "real_estate", "underlyingValue": 500000 }, "tokenDetails": { "symbol": "APT5B", "supply": 1000 }, "campaignDetails": { "startDate": "2023-11-01T09:00:00Z", "endDate": "2023-11-30T17:00:00Z", "goalAmount": 250000 } } ``` ### Response #### Success Response (200) - **tokenId** (string) - The unique identifier for the created token. - **tokenSymbol** (string) - The symbol of the created token. - **campaignId** (string) - The unique identifier for the launched campaign, if applicable. - **status** (string) - The status of the tokenization or campaign. - **message** (string) - Confirmation message. #### Response Example ```json { "tokenId": "token_asset_123", "tokenSymbol": "APT5B", "campaignId": "campaign_xyz789", "status": "active", "message": "Tokenization successful and campaign launched." } ``` ``` -------------------------------- ### Get All NFT Collections (cURL) Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-all-nft-collections This snippet shows how to make a GET request to the Hybrid Chain API to retrieve all NFT collections using cURL. It demonstrates the endpoint and necessary headers. ```shell GET /api/v1/nft/collections/all HTTP/1.1 Host: api.hybrid-chain.com Accept: */* ``` -------------------------------- ### Get Seed Endpoint Specification (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/core-functionality/authentication/auth-get-seed This OpenAPI 3.0 specification defines the AUTH: Get Seed endpoint. It outlines the GET request, required parameters (email or msisdn), and possible responses (200 OK, 400 BAD REQUEST). The seed is used for hashing sensitive information like passwords. ```json {"openapi":"3.0.0","info":{"title":"Hybrid-Chain API Documentation and Specification","version":"1.0.0"},"servers":[{"url":"https://api.hybrid-chain.com/api/v1"}],"paths":{"/auth/seed":{"get":{"tags":["Authentication"],"summary":"AUTH: Get Seed","description":"**Seeds are required and needed when passing around passwords and very sensitive information.**\n\nFor instance, the seed is used to hash the password when logging in a user.\n\n**Use the Unique User Identifier ('email' or 'msisdn' parameter) to correctly link the user profile.**","parameters":[{"name":"email","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Server":{"schema":{"type":"string"}},"Date":{"schema":{"type":"string"}},"Content-Type":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}},"Connection":{"schema":{"type":"string"}},"Cache-Control":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Strict-Transport-Security":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"BAD REQUEST","headers":{"Content-Type":{"schema":{"type":"string"}},"Content-Length":{"schema":{"type":"integer"}},"Cache-Control":{"schema":{"type":"string"}},"Connection":{"schema":{"type":"string"}},"keep-alive":{"schema":{"type":"string"}},"Access-Control-Allow-Origin":{"schema":{"type":"string"}},"Server":{"schema":{"type":"string"}},"Date":{"schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object"}}}}}}}}}}} ``` -------------------------------- ### NFT: Get all available NFTs Source: https://dev.hybrid-chain.com/api-docs/nft-super-store/nft-get-all-available-nfts Retrieves a list of all available NFTs from the Hybrid-Chain API. ```APIDOC ## GET /api/v1/nft/tokens/all ### Description Retrieves a list of all available NFTs. ### Method GET ### Endpoint /api/v1/nft/tokens/all ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **(object)** - A JSON object containing NFT data. #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### WALLET: Get Additional Funding Options Link (OpenAPI) Source: https://dev.hybrid-chain.com/api-docs/core-functionality/vault-wallet-functions/wallet-get-funding-options This OpenAPI specification defines an endpoint to retrieve a URL for purchasing cryptocurrency. The link allows users to buy crypto via credit/debit cards and other regional payment methods. The link is time-sensitive and intended for single use. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/wallet/additional_deposit_options_link": { "get": { "tags": [ "Vault / Wallet Functions" ], "summary": "WALLET: Get Additional Funding Options Link", "description": "This end-point returns a URL Link that can be shown in the browser (or within an iFrame, or Web-View on a mobile device) which will allow the user to buy crypto via their Credit/Debit Cards and other payment methods depending on their location and region (Payment methods may include: Apple Pay, Google Pay, Bank Transfer, etc).\n\nNote: This Link expires after a few minutes and cannot be used by multiple users (sharing it will trigger an automatic expiry of the link for security reasons),\n", "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Connection": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Strict-Transport-Security": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ``` -------------------------------- ### Get All Payment Requests (JSON) Source: https://dev.hybrid-chain.com/api-docs/sales-and-payments-functions/payment-functions/pay-get-all-payment-requests This snippet demonstrates the OpenAPI 3.0 specification for the 'PAY: Get All Payment Requests' endpoint. It outlines the request method, expected response, and security requirements. ```json { "openapi": "3.0.0", "info": { "title": "Hybrid-Chain API Documentation and Specification", "version": "1.0.0" }, "servers": [ { "url": "https://api.hybrid-chain.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "paths": { "/pay/get_payment_requests": { "post": { "tags": [ "Payment Functions" ], "summary": "PAY: Get All Payment Requests", "description": "This Endpoint returns a list of all Payment Requests generated. Full details can individually be pulled via the \"Get Payment Request Details\" Endpoint.", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "OK", "headers": { "Server": { "schema": { "type": "string" } }, "Date": { "schema": { "type": "string" } }, "Content-Type": { "schema": { "type": "string" } }, "Content-Length": { "schema": { "type": "integer" } }, "Connection": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "type": "string" } }, "Access-Control-Allow-Origin": { "schema": { "type": "string" } }, "Content-Encoding": { "schema": { "type": "string" } }, "Vary": { "schema": { "type": "string" } }, "Strict-Transport-Security": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object" } } } } } } } } } ```