Developer Guide
Introduction
As a developer, you have two primary options for accessing data from the Masa network:
- Run your own node and access data locally
- Use the Developer API (requires contacting us through Discord)
This guide will walk you through both options, helping you choose the best approach for your needs.
Option 1: Running Your Own Node
Running your own node allows you to access data directly from the Masa network. This option provides more control and potentially faster access to data.
Steps:
-
Install and Configure Your Node
- Follow our Binary Installation Guide or Docker Setup Guide
-
Stake Your Node
- Complete the Staking Guide to ensure your node is properly staked on the network
-
Connect to the Main Masa Network
- Ensure your node is configured to connect to the main Masa network using mainnet bootnodes
-
Configure API Access (Optional)
- By default, the API server is disabled for security reasons
- If you need to enable the API server, refer to our API Configuration Guide
:::warning Enabling the API server may expose sensitive functionality and data. Only enable it if you understand the security implications and have implemented proper security measures. :::
-
Access Data Locally
- Once your node is running and synced, you can access data through the local API endpoints at http://localhost:8080/swagger/#/
Example API Request:
Option 2: Developer API
If you prefer not to run your own node or need access to specific features, you can use our Developer API.
Steps:
-
Join Our Discord
- Join the official Masa Discord server: https://discord.gg/masafinance
-
Request API Access
- Contact our team through the designated developer channel in Discord
- Provide information about your project and data needs
-
Receive API Credentials
- Once approved, you’ll receive your unique API key and endpoint information
-
Integrate the API
- Use the provided documentation to integrate the Developer API into your application
Benefits of the Developer API:
- No need to run and maintain your own node
- Access to potentially more data sources or advanced features
- Direct support from the Masa team
Choosing the Right Option
-
Run Your Own Node if you:
- Need full control over your data access
- Want to contribute to the network’s decentralization
- Have the technical resources to maintain a node
-
Use the Developer API if you:
- Want a simpler setup process
- Need access to specific features not available through local nodes
- Prefer direct support from the Masa team
Next Steps
- For running your own node, proceed to the Binary Installation Guide
- To use the Developer API, join our Discord and reach out in the developer channel
- Explore our API Documentation for detailed endpoint information
If you have any questions, don’t hesitate to ask in our Discord community!