Natives
Access FiveM and RedM native functions and documentation.
The Natives API provides comprehensive access to FiveM and RedM native functions, including detailed documentation, parameters, and usage examples. This API helps developers find and understand native functions for both GTA V and Red Dead Redemption 2.
Overview
The Natives API is a powerful tool for accessing native function documentation for FiveM and RedM development. It provides:
- Complete native function databases for GTA V and RDR3
- CitizenFX-specific natives and extensions
- Detailed parameter and return type information
- Search and filtering capabilities
- Cross-reference support between different environments
The API covers three main categories:
- GTA V Natives - Standard Rockstar natives for Grand Theft Auto V
- RDR3 Natives - Standard Rockstar natives for Red Dead Redemption 2
- CitizenFX Natives - FiveM/RedM specific extension natives
Base URL
Authentication
The Natives API is currently public and doesn't require authentication. Rate limiting is applied to ensure fair usage.
Endpoints
GET /api/natives
Retrieves native function information with comprehensive filtering and search capabilities.
Query Parameters
Parameter | Type | Description | Default |
---|---|---|---|
game | string | Target game (gta5 , rdr3 , or cfx ) | All games |
search | string | Search query for native names or descriptions | No search |
namespace | string | Filter by specific namespace (e.g., PLAYER , VEHICLE ) | All namespaces |
environment | string | Filter by environment (client , server , shared ) | All environments |
hash | string | Get specific native by hash | No filter |
name | string | Get specific native by name | No filter |
type | string | Filter by return type | All types |
limit | number | Maximum number of results (max 1000) | 100 |
offset | number | Number of results to skip (for pagination) | 0 |
includeDeprecated | boolean | Include deprecated natives | false |
sortBy | string | Sort field (name , namespace , hash ) | name |
sortOrder | string | Sort direction (asc or desc ) | asc |
Response Format
Example Usage
Use Cases
Finding Player Functions
Cross-Platform Native Discovery
Native Implementation Helper
Data Sources
The Natives API aggregates data from multiple sources:
- Rockstar Native Databases - Official native definitions
- CitizenFX Documentation - FiveM/RedM specific natives
- Community Contributions - Enhanced descriptions and examples
- Automated Analysis - Parameter type inference and validation
Performance Considerations
- Native data is cached for optimal performance
- Search operations are optimized with indexing
- Large result sets support pagination
- Response compression is enabled
Rate Limiting
- 200 requests per minute per IP address
- Burst allowance of 50 requests
- Headers indicate current rate limit status
Error Handling
Standard HTTP status codes:
200
: Success400
: Bad Request - Invalid parameters404
: Not Found - Native not found429
: Too Many Requests - Rate limit exceeded500
: Server Error
Example error response:
Best Practices
-
Search Optimization
- Use specific search terms to reduce result sets
- Combine namespace and environment filters
- Implement client-side caching for frequently accessed natives
-
Performance
- Use pagination for large result sets
- Cache native information in your application
- Implement proper error handling and retries
-
Integration
- Validate native existence before implementation
- Cross-reference between game versions
- Use environment filters for client/server-specific code
-
Documentation
- Always include parameter descriptions in your code
- Reference the native hash for verification
- Document environment requirements
Support
For questions about the Natives API, please join our Discord. Our community can help with:
- Native usage examples
- Cross-platform compatibility
- Parameter clarification
- Implementation guidance
The Natives API is continuously updated with new native discoveries and improved documentation.
Always verify native compatibility with your target FiveM/RedM version before implementation.