> ## Documentation Index > Fetch the complete documentation index at: https://docs.xerobi.com/llms.txt > Use this file to discover all available pages before exploring further. # Custom Speed Test > Runs a full speed test against a specific test server. **Use Cases:** - Test performance to specific regions - Compare different server locations - Validate network routing - Geographic performance testing **Note**: Server must be available (check /servers endpoint first). Executes a custom speed test with user-defined parameters and test options. ## OpenAPI ````yaml POST /custom openapi: 3.1.0 info: title: Xerobi Speed Test API description: >- A comprehensive network speed testing API with advanced metrics, real-time progress tracking, result history, and comparative analysis. ## Overview The Xerobi Speed Test API provides powerful network performance testing capabilities: - **Basic Metrics**: Individual tests for ping, jitter, download, and upload speeds - **Advanced Tests**: Multi-file testing for more accurate measurements - **Full Speed Tests**: Comprehensive analysis with quality scoring - **Real-time Monitoring**: Server-Sent Events (SSE) for live progress tracking - **Historical Data**: Store and retrieve test results with statistics - **Comparative Analysis**: Compare results over time - **Server Selection**: Test against specific servers ## Authentication Most endpoints require the `Xerobi-Version` header: ```bash curl -H "Xerobi-Version: 2.0.0" \ https://api.hixbe.com/speedtest/full ``` **Exceptions**: The `/` (docs) and `/health` endpoints don't require this header. ## Rate Limits - **Basic endpoints** (ping, download, upload): 60 requests/minute - **Full/Advanced tests**: 10 requests/minute - **Results/Stats endpoints**: 120 requests/minute Rate limit information is included in response headers. ## Test Result Storage Results from these endpoints are automatically stored: - `/ping` - Basic latency tests - `/download` - Download speed tests - `/upload` - Upload speed tests - `/full` - Comprehensive tests - `/advanced` - Advanced multi-file tests Each stored result receives a unique ID for later retrieval. ## Quality Score Calculation The quality score (0-100) is calculated based on: - **Ping** (30%): < 20ms = excellent, < 50ms = good, < 100ms = fair - **Jitter** (20%): < 5ms = excellent, < 15ms = good, < 30ms = fair - **Download** (25%): Relative to expected speeds - **Upload** (20%): Relative to expected speeds - **Packet Loss** (5%): 0% = perfect, < 1% = excellent, < 5% = acceptable ## Server-Sent Events (SSE) The `/stream` endpoint provides real-time progress updates: ```javascript const eventSource = new EventSource('/speedtest/stream', { headers: { 'Xerobi-Version': '2.0.0' } }); eventSource.addEventListener('ping', (e) => { const data = JSON.parse(e.data); console.log('Ping:', data.result, 'ms'); }); eventSource.addEventListener('finish', (e) => { const data = JSON.parse(e.data); console.log('Complete:', data.result); eventSource.close(); }); ``` ## Best Practices 1. **Use appropriate test types**: Use basic tests for quick checks, advanced tests for accuracy 2. **Handle rate limits**: Implement exponential backoff for retries 3. **Store results**: Use result IDs to track performance over time 4. **Compare wisely**: Use `/comparison` and `/stats` for trend analysis 5. **Real-time updates**: Use `/stream` for UI progress indicators 6. **Server selection**: Use `/servers` to find optimal test servers ## Support - Website: https://hixbe.com - Documentation: https://docs.hixbe.com/speedtest - Status: https://status.hixbe.com version: 2.0.0 contact: name: Xerobi Support url: https://hixbe.com email: support@xerobi.com license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://api.hixbe.com/speedtest description: Production server security: [] tags: - name: Information description: API information, documentation, and health checks - name: Basic Metrics description: Individual speed test metrics (ping, jitter, download, upload) - name: Advanced Tests description: Comprehensive and multi-file speed tests for accuracy - name: Results & History description: Retrieve stored test results with filtering and statistics - name: Real-time description: Real-time test monitoring via Server-Sent Events (SSE) - name: Servers description: Test server management and selection paths: /custom: post: tags: - Servers summary: Run Test on Custom Server description: |- Runs a full speed test against a specific test server. **Use Cases:** - Test performance to specific regions - Compare different server locations - Validate network routing - Geographic performance testing **Note**: Server must be available (check /servers endpoint first). operationId: runCustomTest parameters: - $ref: '#/components/parameters/HixbeVersion' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CustomTestRequest' example: serverId: 1 responses: '200': description: Custom server test completed successfully content: application/json: schema: $ref: '#/components/schemas/FullTestResponse' '400': description: Missing serverId or invalid server content: application/json: schema: $ref: 27a5a76f-6b9d-4bba-98be-3980b44922b5 example: success: false timestamp: '2025-12-07T10:30:00.000Z' error: code: invalid_request message: serverId is required type: ValidationError '404': description: Server not found content: application/json: schema: $ref: 27a5a76f-6b9d-4bba-98be-3980b44922b5 example: success: false timestamp: '2025-12-07T10:30:00.000Z' error: code: not_found message: Server with ID 999 not found type: NotFoundError '500': $ref: 48df11c3-12e7-4b5c-965c-acb0684491d2 components: parameters: HixbeVersion: name: Xerobi-Version in: header description: API version header. Required for all endpoints except / and /health required: true schema: type: string pattern: ^\d+\.\d+\.\d+$ example: 2.0.0 schemas: CustomTestRequest: type: object properties: serverId: type: integer description: ID of the test server to use example: 1 minimum: 1 required: - serverId FullTestResponse: type: object properties: success: type: boolean timestamp: type: string format: date-time data: type: object properties: id: type: integer example: 10 ping: type: object properties: value: type: number unit: type: string jitter: type: object properties: value: type: number unit: type: string download: type: object properties: value: type: number unit: type: string upload: type: object properties: value: type: number unit: type: string packetLoss: type: object properties: value: type: number minimum: 0 maximum: 100 unit: type: string enum: - '%' qualityScore: type: object properties: value: type: integer minimum: 0 maximum: 100 maxScore: type: integer example: 100 rating: type: string enum: - Excellent - Good - Fair - Poor geo: type: object properties: country: type: string region: type: string city: type: string nullable: true latitude: type: number nullable: true longitude: type: number nullable: true connectionType: type: string example: Fiber isp: type: string example: Xerobi Fiber required: - id - ping - download - upload - qualityScore executionTime: type: string ```` ## Related topics - [Get speed test configuration](https://docs.xerobi.com/network-api/endpoint/get-speedtest-config.md) - [Xerobi Speed Test API](https://docs.xerobi.com/speed-api/introduction.md) - [Download Speed Test](https://docs.xerobi.com/speed-api/endpoint/download-test.md) - [Upload Speed Test](https://docs.xerobi.com/speed-api/endpoint/upload-test.md) - [Advanced Speed Test](https://docs.xerobi.com/speed-api/endpoint/advanced-test.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.