FP
FIREPAN

API Reference

Detailed API documentation with endpoints, parameters, and response formats for direct integration.

Developer Resources

← Back to Developer Hub

Coming Soon

Our API reference documentation is currently under development. Check back soon for detailed endpoint specifications.

API Overview

Firepan's API provides programmatic access to our smart contract security infrastructure, allowing developers to scan contracts, retrieve audit reports, and integrate security into CI/CD pipelines.

Key Features

  • RESTful API design with predictable resource-oriented URLs
  • JSON-encoded request and response bodies
  • OAuth 2.0 authentication and fine-grained permission controls
  • Comprehensive error handling with detailed error messages
  • Rate limiting with clear headers indicating usage and limits
  • Webhook support for real-time event notifications

API Endpoints

Resource
Description
Status
/scan
Submit contracts for security analysis
Coming Soon
/reports
Retrieve audit reports and findings
Coming Soon
/monitor
Configure real-time contract monitoring
Coming Soon
/webhooks
Configure security alert notifications
Coming Soon