# Welcome to PX
Harness the power and security of decentralized storage with PollinationX (PX) Storage NFTs or experience out-of-the-box integration with PX custom APIs & SDK.
π‘
Discover PollinationX (PX)
Decentralized storage infrastructure and service layer.
### Mission;
*To bridge the gap between decentralized storage networks and end users enabling ease of access while democratizing access to secure and private storage solutions empowering a new era of data sovereignty and security.*
### Context
{% hint style="danger" %}
**Problem:** In today's digital age, data is incredibly valuable, often compared to oil. However, the explosion of digital data has made it increasingly difficult to manage, store, and protect. Traditional cloud storage providers capitalize on data mining, but this approach has significant flaws, including loss of data ownership and custody once data is uploaded, as well as overstated security claims. This centralized model is problematic both technically and ideologically, as it places users' personal and sensitive data under the control of large corporations. These issues have driven the shift towards decentralized storage systems, offering a new approach to data management.
{% endhint %}
{% hint style="info" %}
**Solution:** The up-and-coming decentralized storage networks could be presented as a solution as their self-custodial decentralized design abstracts the possibilities of data mining and data ownership loss putting the data owner in control. Amidst this landscape, PX emerges as a beacon of innovation, bridging the gap between the theoretical promise of decentralized storage and its practical application, adding infrastructure and service layer dedicated to the ease of access.
{% endhint %}
### What is PollinationX (PX)?
{% tabs %}
{% tab title="Intro to PX Infra" %}
{% embed url="" %}
{% endtab %}
{% tab title="Intro to PX dApp" %}
{% embed url="" %}
{% endtab %}
{% tab title="Intro to PX Storage NFTs" %}
{% embed url="" %}
{% endtab %}
{% endtabs %}
PollinationX is a decentralized storage infra layer that provides developers access to custom decentralized storage nodes and offers end-users dynamic [NFTs](https://wiki.pollinationx.io/overview/px-storage-nft) with preset storage and bandwidth capacities. offers a suite of back-end services that enable developers to connect to custom decentralized storage nodes via dedicated service APIs & SDK while utilising the read-and-write methods of [supported decentralized storage](/overview/supported-networks-and-storages) out-of-the-box.
PX emerges as a beacon of innovation, bridging the gap between the theoretical promise of decentralized storage and its practical application, adding infrastructure and service layers dedicated to ease of access.
{% hint style="info" %}
**Meaning:** The name PollinationX derives from the pollination process in nature. The same as plant spores are distributed from one flower to another, your files are split into smaller pieces, encrypted and dispersed between various PollinationX nodes. At the same time, data reunification is possible only with the user's private key. In addition, PollinationX "pollinates" applications by connecting solutions from diverse developers. Once you upload your files become instantly accessible across any app integrated with PollinationX.
{% endhint %}
{% hint style="success" %}
**PX technology is build based on decentralized principles;**
(1) pseudonymous login via Web3 wallets;\
(2) self-custodial;\
(3) on-chain verifiable;\
(4) users data is accessible only to the private key owner; \
(5) no personal data whatsoever is collected or can be accessed by the PX service, and; \
(6) open-source & open-source with commercial restrictions.
{% endhint %}
### Products
* **PX dApp:** Simplifies the usage of decentralized storage networks while serving as a developer dashboard and an end-user file hosting service.
* **PX Storage NFT:** Represent the storage and bandwidth quotas in a mintable, portable ans self-custodial form.
* **Developers Tools:** Offers a suite of back-end services that enable connection to custom decentralized storage nodes via dedicated service APIs & SDK while utilising the read-and-write methods of supported decentralized storage out-of-the-box.
### Official Links
{% tabs %}
{% tab title="PollinationX" %}
```
https://pollinationx.io/
https://wiki.pollinationx.io/
https://github.com/pollinationx/
```
{% endtab %}
{% tab title="PX dApp" %}
```
https://app.pollinationx.io/
https://testnet.pollinationx.io/
https://github.com/pollinationx/px-dapp/
```
{% endtab %}
{% endtabs %}
# FAQ
## Let's get started
### 1. What is PollinationX?
PollinationX is a decentralized storage infra layer that provides developers access to custom decentralized storage nodes and offers end-users dynamic NFTs with preset storage and bandwidth capacities.
### 2. Why is decentralized storage important?
Compared with centralized storage, geographically dispersed decentralized storage network has no single point of failure. Your data is broken into 1000s of pieces and dispersed through the network decentralized storage nodes. Access is permissionless, while data retrieval is possible only with the users private key.
### 3. Is decentralized storage free?
PollinationX offers first 100MB of decentralized storage and 25 Bandwidth for free. Users can upgrade their storage using [PX sNFTs](/overview/px-storage-nft) available in various sizes (e.g. 5GB, 10GB, 20GB, 100GB). If compared with centralized storage solutions, one must acknowledge that some storage plans could offer "free" packages in exchange for associated users data, which is mined and sold. This is not the case with PollinationX.
## Data security and privacy
### 4. Is data ownership preserved?
Yes, compared to centralized storage where users don't have control over their data, decentralized storage enables full data custody while retaining data ownership.
### 5. Who can access the data?
Data can be accessed only with the users private key!
### 6. Can I delete my data from PX Drive?
You can delete files from your PX Drive account. Simply connect to your PX Drive account and use the delete function in the file manager. This will remove the files from your account, but they will still remain on the decentralized storage network.
However, once a file is uploaded to decentralized storage, there cannot be a guarantee that all copies of the file are gone from the decentralized storage network. As soon as a file is uploaded, other decentralized storage nodes can access and store a copy of the data. The data only becomes unavailable when the last decentralized storage node has stopped pinning the file, and all copies are garbage collected.
## Other
### What is the PX sNFT?
PX Storage NFT is a dynamic NFT programmed with a predetermined storage capacity. It represent the decentralized storage unit (e.g. 5GB, 10GB, 20GB, 100GB) and enable users to mint the storage according to specific needs. The PX sNFT is based on the open-source `[PX]` smart contract.
### What is bandwidth?
Bandwidth Defines how many data files can be uploaded to decentralized storage. It acts as a metric used within the PX Storage NFT mechanics (i.e. 1 bandwidth = 1 data file upload).
### What is PX dApp?
PX app is a decentralized application, a developer dashboard and an end-user file hosting service. It is built to service developers while managing subscriptions or accessing a range of developer settings and tools. It is also built for end-users. It offers a file hosting service with cutting-edge decentralized storage solutions that empower users with full control and ownership of their data.
# Library
Dive deeper into 3+ years of research and development, discover what we learned putting together this amazing decentralisation storage infrastructure.
πPollinationX (PX); Decentralized Storage Infrastructure and Service Layer
PX Whitepaper, David Tacer, Dr. Tali ReΕΎun & Denis Jazbec, 2024
# PX dApp
PollinationX dApp is a decentralized application, a developer dashboard and an end-user file hosting service.
The PX dApp is built to service developers while managing subscriptions or accessing a range of developer settings and tools. It is also built for end-users like you and me. It offers a file hosting service with cutting-edge decentralized storage solutions that empower users with full control and ownership of their data. Through dynamic Storage NFTs, users can securely manage their storage quotas and bandwidth capacities. The app provides a familiar "Cloud Storage" experience, syncing files across devices in a self-custodial, permissionless manner, ensuring that your digital assets remain private and secure across all platforms, accessible only to the private key owner.
* **End-users:** A decentralized storage service offering a "Cloud Storage Drive" experience, where users can store and access files online in a self-custodial, permissionless way. It syncs documents, photos, and more across all devices supporting Web3 wallets.
* **Developers:** A integrator-focused dashboard that allows developers to manage their PX subscriptions and access a range of developer settings and tools.
{% embed url="" %}
{% embed url="" %}
### **Fundamentals**
* Pseudonymous access via Web3 login
* Self-custodial, censorship-resistant, and permissionless
* Resistant no data mining
* Data access possible only with users' private key
* Multi-chain
* Open-source
### Technicals
The diagram illustrates the PX dApp processes between user wallets, platform, data, blockchain and decentralized storage.
{% hint style="info" %}
**Note:** Check the [PX processes](https://wiki.pollinationx.io/developer-section/px-processes) chapter for detailed descriptions of the PX dApp processes running in the back end.
{% endhint %}
### Resources
{% embed url="" %}
# PX dApp User Guide
This is the PollinationX dApp manual page. Follow the steps for easier onboarding and access to all needed information.
1οΈβ£ Connect to the dApp
Install, login, fund your wallet and connect to PX App.
{% tabs %}
{% tab title="Intro to PollinationX" %}
{% embed url="" %}
{% endtab %}
{% tab title="PX dApp Tutorial" %}
{% embed url="" %}
{% endtab %}
{% tab title="Intro to PX Storage NFTs" %}
{% embed url="" %}
{% endtab %}
{% endtabs %}
### Connecting to the dApp
PX dApp is a Web3-native application supporting [MetaMask](https://support.metamask.io/getting-started/getting-started-with-metamask/) and Wallet Connect. We recommend beginners take the [MetaMask Web3 101](https://learn.metamask.io/overview) course before starting.
Since PX dApp services run on-chain, ensure your wallet has enough gas for setup and operations.
The PX dApp is a multi-chain application. Users can choose between several supported EVM blockchains. We recommend browsing the [supported network list](https://wiki.pollinationx.io/overview/supported-networks-and-storages) and choosing the blockchain most suited to your needs.
Steps:
* βοΈ Install and login to a supported wallet
* π° Fund your wallet with gas
* π€ Connect your wallet with the [PX dApp Testnet](https://testnet.pollinationx.io/) (testnet.pollinationx.io) or [PX dApp Mainnet](https://app.pollinationx.io/) (app.pollinationx.io)
* π Select blockchain
### Setting up the PX dApp account
When you first connect to the PX dApp, you'll need to create or import a PX Storage NFT account. Each PX Storage NFT account has its own encryption with a unique public and private key pair. The private key allows you to export your PX Storage NFT accounts and restore your storage state on any browser-based device.
Steps:
* π **Set up** a password for the account
* π€ **Create** a new account or import a private key of an existing one
* π If creating a new account, be sure to store the account private key securely
* β οΈ **Follow** the instructions carefully to complete the account setup
### **Setting up the dashboard**
The PX dApp dashboard is your mission control within the application. It lets you mint PX Storage NFTs and manage their accounts. It is also a place where devs can access integrator tools and settings.
Steps:
* βοΈ **Mint** PX Storage NFT according to your preferences and confirm the transaction with your wallet, read more in the "[upgrade or mint PX NFT chapter](#upgrade-or-mint-new-storage)"
* π **Access** the account tab to export the account private key (if needed)
* π **Access** the settings tab to reset the private key within the app (if needed)
### Managing and uploading files to decentralized storage
Once youβve set up the dashboard, adding files to your PX storage NFT account is as easy as dragging and dropping from your computerβs file system.
Steps:
* π Create folders
* πΎ Drag and drop the chosen files to the dedicated form within the app and upload the files to decentralized storage - check the upload progress on the right
* β¬οΈ Download, edit or delete files by accessing the additional features menu
{% hint style="info" %}
**Note:** When uploaded, files are split into smaller pieces, encrypted and dispersed between various decentralized storage nodes. At the same time, data reunification is possible only with the user's private key.
{% endhint %}
### **Syncing the file structure state to the blockchain**
The sync with blockchain feature enables syncing the file structure state between different devices.
Steps:
* β¬οΈ Download from blockchain - choose to download the app state
* β¬οΈ Upload to blockchain - choose to upload the app state
{% hint style="danger" %}
**Note:** You have to sync the state to the blockchain first, before you sync it to another device.
{% endhint %}
### Upgrade or mint new storage
PollinationX NFTs enable easy access to decentralized storage. Users can mint decentralized storage NFTs according to their storage needs (e.g. 100MB, 5GB, 20GB, 100GB). Storage is available until used. New storage NFTs can be minted according to the user's need.
Steps:
* π **Upgrade** storage - Upgrade the storage on the existing NFT located in your wallet
* βοΈ **Mint** new storage NFT - Mints a new storage NFT
* π **Refresh** the dynamic NFT creative located at the left bottom of the dApp. Newly minted storage should appear under the usage writing.
### Disclaimer
THE SOFTWARE SET FORTH IN THESE TERMS IS PROVIDED 'AS ISβ, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED WARRANTY THAT THE SOFTWARE IS FREE OF DEFECTS, MERCHANTABLE OR FIT FOR A PARTICULAR PURPOSE. NO ORAL OR WRITTEN INFORMATION OR ADVICE GIVEN BY US.
In no event will the Company, its affiliates, distributors or resellers be liable for any indirect, special, incidental or consequential damages arising out of the use of or inability to use the software, including, without limitation, damages for lost profits, loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses, even if advised of the possibility thereof.
# PX Storage NFTs
PollinationX dynamic sNFTs represent the storage and bandwidth unit, while the NFT image reflects the real-time storage capacity state.
### Intro to PX sNFTs
PX sNFTs are built for both developers and end-users. PX decentralized storage NFTs represent the storage unit and bandwidth upload capacity. Utilizing dynamic NFT technology, the NFT image dynamically updates to represent the real-time status of storage capacity. NFTs come with predefined storage and bandwidth allocations and can be minted to meet specific requirements. Storage usage metrics are synchronized via the \[PXMain] smart contract, ensuring accurate tracking. Based on the selected storage size in gigabytes and the number of bandwidth uploads (i.e. 1 bandwidth = 1 data file upload), PX sNFTs are minted to grant storage access.
### Fundamentals
* Pseudonymous storage access via Web3 login
* Self-custodial
* Robust and resistant to Web2 data mining & data ownership loss
* On-chain verifiable
* No centralized point of failure
* Multi-chain
* Transferable
* Composable
* EVM-native
### Developers
Developers can integrate the PX sNFTs directlly into their apps, enabling users to self-custody their data right out-of-the-box. As an PX sNFT owner, the integrator is authorised to claim credentials to access the PX SDK methods and have access to advanced PX dApp functionalities.
With PX sNFT integration, developers benefit from decentralization storage optimization. There is no need to maintain a larger storage capacity for storage reselling. End users maintain and hold their storage themselves in the form of the PX sNFT.
{% hint style="info" %}
**Note:** The PX sNFT owner is authorised to claim credentials to access the PollinationX SDK methods. The storage size gets updated via NFT \[PXMain] smart contracts when the user uploads the files. When maxing the storage size, a new NFT must be minted.
{% endhint %}
### End-users
Through dynamic Storage NFTs, users can securely manage their storage quotas and bandwidth capacities. Due to the PX sNFT multi-chain nature, users can mint the sNFTs in the domain of their native chain.
### Integrations & Features
{% hint style="info" %}
**Note:** References to USD prices are made for approximate fiat value illustration purposes only. Access [Fees](/overview/fees) chapter for more information.
{% endhint %}
### Adding the PX sNFT to MetaMask
1. Go to MetaMask and access the NFT tab
2. Click β*Import NFT*
3. Fill in the details below:\
\- **Address:** 0x1142b080a5493695e3E35c9C4269f6C06B5CE0F4\
\- **Token ID:** (e.g. #123)
4. Click *Import*
{% hint style="info" %}
**Note:** NFT smart contracts address is no always the same. Check the exact address on the [supported network](https://wiki.pollinationx.io/overview/supported-networks-and-storages) page. Every PX sNFT has its uniqe ID. You can find it on the NFT graphics (# + a specific number) or access it in the NFT mint smart contract transaction.
{% endhint %}
### Resources
{% embed url="" %}
# Supported Networks & Storages
We strive to enable access to decentralized storage no matter to the native L1 or L2.
## Supported Networks
\[PXMain] smart contract represents the [PX sNFT](/overview/px-storage-nft) which acts as a storage unit applicable within various use cases. Multi-chain interoperability directly correlates with \[PXMain] smart contract deployment.
{% tabs %}
{% tab title="Mainnets" %}
| Chain List π | PX smart contracts π | Deployment |
| --------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [Gnosis](https://chainlist.org/chain/100) |
{% endtab %}
{% endtabs %}
## Supported Storage Networks
PollinationX currently supports [BTFS](https://www.btfs.io/) (i.e. BitTorrent File System) and will support other decentralized storage networks in the future.
Decentralized Storage
Status
Version
Node
BTFS
Active
Alpha
/
IPFS
TBA
/
FileCoin
TBA
/
{% hint style="danger" %}
**Warning:** BTFS is in the alpha version. Use it at your own discretion!
{% endhint %}
# Fees
### Fee Table
{% tabs %}
{% tab title="Blockchain Fees" %}
{% endtab %}
{% endtabs %}
{% hint style="info" %}
**\*Note:** Crypto prices are estimated and calculated based on; (1) Fantom 41 GWei, and; (2) Oasis 100 GWei gas price. The "Send message" gas limit is based on the length of the message. The "Create Group" gas limit depends on the number of members in the group and the encryption variable. Table calculation is based on a two-member encrypted group. References to USD prices are made for approximate fiat value illustration purposes only.
{% endhint %}
# PX Architecture
Harnesses the power and security of decentralized storage networks while enabling end-users to access decentralize storage with ease.
### Let's Start
The architecture was designed to be as lightweight and modular as possible while retaining core decentralization primitives. There are five key legos forming the core PX framework:
* Smart contract & libraries
* On-chain storage validation
* PX Nodes
* PX Storage NFT authorisation
* PX client
### Architecture by layers
Connected by the PX SDK (i.e. software development kit), seven layers complete the PollinationX framework:
* dApps & clients (e.g. [PX dApp](https://wiki.pollinationx.io/overview/px-dapp))
* [PX SDK](https://wiki.pollinationx.io/developer-section/px-sdk)
* [PX API](https://wiki.pollinationx.io/developer-section/api-reference)
* [Decentralized storage networks](https://wiki.pollinationx.io/overview/supported-networks-and-storages#supported-storage-networks) (i.e. BTFS, IPFS)
* [Storage nodes](https://wiki.pollinationx.io/developer-section/px-nodes)
* [PX Protocol](https://github.com/PollinationX/smart-contracts)
* PX Assets
* [Blockchain networks](https://wiki.pollinationx.io/overview/supported-networks-and-storages#supported-networks)
### Resources
{% embed url="" %}
{% embed url="" %}
{% embed url="" %}
# PX Processes
### Let's Start
There are numerous processes runing between user wallets, platform, data, blockchain and decentralized storage.
### Minting a PX Storage NFT
Steps:
* The user mints a new PX sNFT on the blockchain.
* The user interacts with the PX sNFT smart contract through the application (dApp) or an explorer\*.
* The smart contract generates a new PX sNFT token and associates it with the user's wallet address.
* During the minting process, the smart contract also saves the BTNS key for the minted PX sNFT.
{% hint style="info" %}
\*If PX sNFT is minted directly on a smart contract via blockchain Explorer, the user needs to make PX sNFT registration through registration management to generate the BTNS key.
{% endhint %}
### PX Storage NFT registration management
The process generates and allocates a unique BTNS key to PX sNFT which is used to reference storage usage metadata on BTFS.
{% hint style="info" %}
**\*IPNS details:**
{% endhint %}
### Uploading files and saving storage usage metadata
Steps:
* The user uploads the files on the PX sNFT (prerequisite; available free PX sNFT storage).
* The files are saved BTFS (or any other supported decentralized storage network).
* Upon successful file upload, the PX Node provides the storage usage for the uploaded file and saves storage usage metadata, which includes storage quota, current usage and the CID of the uploaded file.
* The metadata is stored on BTFS and referenced by PX sNFT assigned BTNS key.
### Syncing mechanism
Steps:
* The user wants to ensure that his storage usage metadata is synchronized with the blockchain, so he triggers a sync operation through the dApp or explorer.
* The user calls the synch function on the PX sNFT smart contract providing the PX sNFT token ID.
* The PX sNFT smart contract uses Chainlink to fetch the latest metadata from BTFS using the user's PX sNFT BTNS key.
* After retrieving the metadata, the PX sNFT smart contract updates users' PX sNFT token on-chain with the latest storage usage information.
### When the user chooses not to synch their storage usage metadata
Users who do not sync their storage usage metadata within the specified timeframe face temporary restrictions on uploading files, and PX sNFT will not allow uploads. After synchronization, PX sNFT will allow uploads again.
{% hint style="info" %}
**Note:** While the PX infrastructure is natively interoperable with IPFS and IPNS, the first production integrations are made using BTFS and BTNS frameworks. Other decentralized storage network support will follow according to the project roadmap.
{% endhint %}
# PX Nodes
We are enhancing the robustness of the PX system with node decentralization.
### Let's Start
The objective is to decentralize the PX infrastructure, enhancing the robustness of the PX system as more nodes operate in a true self-custodial manner. By increasing the number of nodes, we bolster the resilience and autonomy of the PX network, promoting a more secure and democratic ecosystem for all participants.
### DNS link
DNSLink is used for linking DNS records to IPFS content. It allows associating a domain name with a IPFS content identifier (i.e. CID), making it easier to access IPFS content using human-readable domain names. By setting up a DNSLink, we associated a domain name [nodes.pollinationx.io](https://nodes.pollinationx.io/) with the CID of the JSON file containing the list of PX nodes.
### List of Nodes on IPFS
The JSON file stored on IPFS contains a list of URLs to all PX nodes participating in the network. Each URL represents a node's endpoint that can be used to interact with the node. This JSON file serves as a registry of all available nodes, allowing clients to discover and connect to nodes dynamically. Later the PX infrastructure will transit from a IPFS to a smart contract to serve as a registry of nodes. With that approach, anyone will be able to publish a PX node, which will be a significant step towards decentralization and improving the architecture's flexibility.
### IPFS CID
The IPFS CID\* identifies the JSON file containing the list of PX nodes on IPFS. This hash will be later replaced with the IPFS hash. Clients can access this file by resolving the DNSLink to obtain the CID and then fetching the content from the IPFS network.
{% hint style="info" %}
**\*IPFS CID:** bafkreiequiplrkpg6kdxbaraxasa6weohy3bwszowrostbav72pe3fjcqe
{% endhint %}
\*bafkreiequiplrkpg6kdxbaraxasa6weohy3bwszowrostbav72pe3fjcqe
### Healtz API
The Healthz API monitors the availability and status of nodes in the network. It checks whether nodes are online, responsive, and functioning as expected. API provides real-time visibility into the operational status of the network. In addition to monitoring PX nodes, the Healthz API verifies the connectivity and health of the underlying blockchain network. It checks whether the blockchain is online and accessible, ensuring that critical infrastructure components are operational.
### Processes within the PX node:
* The PX Storage NFT authorization process checks the wallet NFT holdings. In case of a positive (i.e. >1) wallet balance, the access token is generated for each NFT.
* The Check Usage process checks if the access token is valid and checks if the uploader has enough storage available on the NFT.
* The data file is transferred to the upload.
* The NFT storage state is synced
{% hint style="info" %}
**Note:** While the PX infrastructure is natively interoperable with IPFS and IPNS, the first production integrations are made using BTFS and BTNS frameworks. Other decentralized storage network support will follow according to the project roadmap.
{% endhint %}
### Resources
{% embed url="" %}
# PX API Reference
Dive into the specifics of each API endpoint by checking out our complete documentation.
## Authentication
Auth authenticates the user and checks their PollinationX (PX) storage NFTs.
{% content-ref url="/pages/HbRfSy16FsK8e6rUS2Qv" %}
[Auth](/developer-section/px-api-reference/auth)
{% endcontent-ref %}
## File management
This API endpoints for uploading and downloading files to/from decentralized storage.
{% content-ref url="/spaces/dhAnLhcEtZNDPAiBQKzC/pages/1TGSYX8K6VDh7GI0nRya" %}
[Upload](/developer-section/px-api-reference/upload)
{% endcontent-ref %}
{% content-ref url="/spaces/dhAnLhcEtZNDPAiBQKzC/pages/idpg62K5f32dJjwBQS6L" %}
[Download](/developer-section/px-api-reference/download)
{% endcontent-ref %}
{% hint style="info" %}
**Good to know:** To enhance security and privacy, consider encrypting files before uploading them to the decentralized storage. This way, even if the storage nodes are compromised, the data remains protected. If you want encryption out of the box consider using our [PollinationX SDK](/developer-section/px-sdk).
{% endhint %}
# Auth
Auth authenticates the user and checks their PollinationX (PX) storage NFTs.
## Authentication
## Authenticate user
`GET` `/auth/login`
#### Query Parameters
| Name | Type | Description |
| ------------------------------------------- | ------ | --------------------------------------------------------------------------------- |
| wallet\* | String | The user's wallet address. |
| chain \* | String | The chain identifier. |
| nonce\* | String | A non-reusable value provided by the client to prevent replay attacks. |
| signature\* | String | The signature generated by signing the request data using the user's private key. |
{% tabs %}
{% tab title="200 Authentication successfull" %}
```json
{
"success": true, // Indicates whether the request was successful or not.
"nfts": // An array of NFT objects.
[
{
"contract": {
"address": Address of the NFT contract,
},
"id": {
"tokenId": Unique identifier of the NFT,
"tokenMetadata": {
"tokenType": Type of the token
}
},
"balance": Balance of the NFT,
"title": Name of the NFT,
"description": Description of the NFT,
"tokenUri": {
"gateway": Gateway URL for accessing the token URI,
"raw": Raw token URI
},
"media": [
{
"gateway": Gateway URL for accessing the media file,
"thumbnail": URL of the thumbnail image associated with the media,
"raw": Base64 encoded SVG image data,
"format": "svg+xml",
"bytes": media size
}
],
"metadata": {
"name": Name of the NFT metadata,
"description": Description of the NFT metadata,
"image": Base64 encoded SVG image data for the NFT metadata,
"attributes": [
{
"display_type": "boost_percentage", // Display type of the attribute
"value": 3, // Value of the attribute define how much storage is already used
"trait_type": "Usage" // Trait type of the attribute.
},
{
"value": "5GB", // Maximum PX Storage NFT capacity
"trait_type": "Capacity"
}
]
},
"timeLastUpdated": Timestamp indicating the last update time,
"contractMetadata": {
"name": Name of the NFT contract metadata,
"symbol": Symbol of the NFT contract metadata,
"tokenType": Type of the token supported by the contract,
"contractDeployer": Address of the contract deployer,,
"deployedBlockNumber": Block number at which the contract was deployed,
"openSea": {
"lastIngestedAt": Timestamp indicating the last ingestion time by OpenSea.
}
},
"jwt": JWT (JSON Web Token) for authentication purposes,
"endpoint": API endpoint for interacting with the PollinationX.
},
],
"totalCount": Total count of NFTs returned
}
```
{% endtab %}
{% tab title="500: Internal Server Error Authentication failed" %}
```json
{ error: Error message }
```
{% endtab %}
{% endtabs %}
{% hint style="info" %}
**Tip:** This endpoint allows you to authenticate a user and check their PollinationX (PX) storage NFTs without triggering a blockchain transaction or incurring any gas fees.
{% endhint %}
### Auth URL:
{% embed url="" %}
The URL link defines which parameters must be sent. The user proves the storage ownership (i.e. PX sNFT) by signing with MetaMask. PX sNFTs are available for minting at the [PX Dashboard](broken://pages/uZ7WbNdgG6gJ3kJmMD9C).
# Upload
This API endpoint allows you to add a file to the decentralized storage.
{% hint style="info" %}
**Good to know:** Upload API automatically checks the NFT holder storage quota.
{% endhint %}
{% hint style="warning" %}
If using API for uploading, files are not encrypted. Do not store any private or sensitive information in an unencrypted way. If you want encryption out of the box consider using our [PollinationX SDK](/developer-section/px-sdk).
{% endhint %}
## Upload file
## Upload file
`POST` `/api/v1/add`
API endpoint and JWT token is available in [Authenticate user](#authenticate-user) api response.
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------------------- | --------------------------------------------------- |
| Authorization\* | Bearer \ | he authentication token required to access the API. |
#### Request Body
| Name | Type | Description |
| -------------------------------------- | ------------------- | ---------------------------------- |
| file\* | multipart/form-data | The file to be added to the system |
{% tabs %}
{% tab title="200 The request was successful" %}
```json
{
"Name": "The name of the uploaded file",
"Hash": "The Content Identifier (CID) of the file on the decentralized storage. It uniquely identifies the file and can be used to retrieve or reference it.",
"Size": "The size of the uploaded file in bytes"
}
```
{% endtab %}
{% tab title="500: Internal Server Error An error occurred while processing the request" %}
```json
{ error: Error message }
```
{% endtab %}
{% tab title="401: Unauthorized The request lacks valid authentication credentials or the provided token is invalid" %}
{% endtab %}
{% endtabs %}
{% hint style="info" %}
The provided CID (`"Hash"`) in api response can be used to interact with the decentralized storage system to retrieve or manipulate the file as needed.
{% endhint %}
# Download
This API allows you to download a file from the decentralized storage using its Content Identifier (CID)
{% hint style="info" %}
**Good to know:** Consider the size of the file you are downloading and the network conditions. Larger files may take longer to download, so ensure that your application handles file downloads efficiently and provides progress indications if needed.
{% endhint %}
## Download file
## Download file
`POST` `/api/v1/get`
API endpoint and JWT token is available in [Authenticate user](#authenticate-user) api response.
#### Query Parameters
| Name | Type | Description |
| ------------------------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| arg\* | String | The Content Identifier (CID) of the file you want to download from the decentralized storage system |
#### Headers
| Name | Type | Description |
| ----------------------------------------------- | ------------------- | --------------------------------------------------- |
| Authorization\* | Bearer \ | he authentication token required to access the API. |
{% tabs %}
{% tab title="200 The request was successful" %}
```
Binary image
```
{% endtab %}
{% tab title="500: Internal Server Error An error occurred while processing the request" %}
```json
{ error: Error message }
```
{% endtab %}
{% tab title="401: Unauthorized The request lacks valid authentication credentials or the provided token is invalid" %}
{% endtab %}
{% endtabs %}
{% hint style="info" %}
The provided CID (`"Hash"`) in api response can be used to interact with the decentralized storage system to retrieve or manipulate the file as needed.
{% endhint %}
# PX SDK
Interact with the PollinationX APIs using the PollinationX SDK. With just a few lines of code, unlock the potential of PollinationX's infrastructure.
The PX SDK is a comprehensive, stable, and powerful Javascript SDK in place to interact with the PX architecture.
# Quick start
### Instal the SDK:
```
npm i @pollinationx/core
```
### Resources
{% embed url="" %}