> ## 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. # Get consumer network info > Returns current network configuration including IP addresses, plan details, and service status for the authenticated consumer account. **Use Cases:** - Display current IP address in customer portal - Check service status before troubleshooting - Verify plan details and connection type Returns current network configuration including IP addresses, plan details, and service status for the authenticated consumer account. **Use Cases:** * Display current IP address in customer portal * Check service status before troubleshooting * Verify plan details and connection type ## OpenAPI ````yaml GET /consumer/network openapi: 3.1.0 info: title: Xerobi Fiber API description: >- API for Xerobi Fiber customers and business clients. ## Overview The Xerobi Fiber API provides two distinct interfaces: - **Consumer API**: Simple, user-friendly endpoints for residential customers to check their network status, account details, usage statistics, and run speed tests. - **Business API**: Advanced endpoints for enterprise clients to manage IP assignments, monitor bandwidth usage, and automate network operations. ## Authentication All endpoints require Bearer token authentication. Include your JWT token in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` Tokens can be obtained from your Xerobi account dashboard. ## Versioning All requests must include the `Hixe-Version` header with the API version date (format: YYYY-MM-DD). Current version: `2026-01-01` ## Rate Limiting - Consumer endpoints: 100 requests per minute - Business endpoints: 1000 requests per minute Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests allowed - `X-RateLimit-Remaining`: Requests remaining in current window - `X-RateLimit-Reset`: Unix timestamp when the limit resets version: '2026-01-01' contact: name: Xerobi API Support email: support@xerobi.com url: https://support.hixbe.com license: name: Proprietary url: https://hixbe.com/terms servers: - url: https://api.hixbe.com/fiber description: Production API security: - bearerAuth: [] tags: - name: Consumer description: Endpoints for residential customers - name: Business description: Endpoints for enterprise clients paths: /consumer/network: get: tags: - Consumer summary: Get consumer network info description: >- Returns current network configuration including IP addresses, plan details, and service status for the authenticated consumer account. **Use Cases:** - Display current IP address in customer portal - Check service status before troubleshooting - Verify plan details and connection type operationId: getConsumerNetwork parameters: - $ref: '#/components/parameters/hixeVersionHeader' responses: '200': description: Successfully retrieved network information content: application/json: schema: $ref: '#/components/schemas/ConsumerNetwork' example: ip: 203.0.113.42 ipv6: 2001:db8::1 plan: Fiber 1000 status: active connection_type: FTTH max_speed_mbps: 1000 '401': $ref: '#/components/responses/UnauthorizedError' '429': $ref: '#/components/responses/RateLimitError' components: parameters: hixeVersionHeader: name: Hixe-Version in: header description: 'API version in YYYY-MM-DD format. Current version: 2026-01-01' required: true schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ example: '2026-01-01' schemas: ConsumerNetwork: type: object description: >- Network information for consumer account including IP addresses and service status properties: ip: type: string description: Assigned IPv4 address example: 203.0.113.42 ipv6: type: string description: Assigned IPv6 address (if available) example: 2001:db8::1 nullable: true plan: type: string description: Current subscription plan name example: Fiber 1000 enum: - Fiber 100 - Fiber 500 - Fiber 1000 - Fiber 2000 status: type: string description: Current service status enum: - active - suspended - pending example: active connection_type: type: string description: Type of fiber connection enum: - FTTH - FTTB - FTTC example: FTTH max_speed_mbps: type: integer description: Maximum download speed in Mbps for current plan example: 1000 required: - ip - plan - status Error: type: object description: Standard error response properties: error: type: object properties: code: type: string description: Error code for programmatic handling example: invalid_request message: type: string description: Human-readable error message example: The Hixe-Version header is required details: type: object description: Additional error details nullable: true required: - code - message required: - error responses: UnauthorizedError: description: Authentication failed - invalid or missing token content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: unauthorized message: Invalid or expired authentication token RateLimitError: description: Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: rate_limit_exceeded message: Too many requests. Please retry after 60 seconds headers: X-RateLimit-Limit: schema: type: integer description: Maximum requests allowed per window X-RateLimit-Remaining: schema: type: integer description: Requests remaining in current window X-RateLimit-Reset: schema: type: integer description: Unix timestamp when rate limit resets Retry-After: schema: type: integer description: Seconds to wait before retrying securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: JWT token obtained from Xerobi account dashboard ```` ## Related topics - [Get consumer account info](https://docs.xerobi.com/network-api/endpoint/get-consumer-account.md) - [Get consumer usage stats](https://docs.xerobi.com/network-api/endpoint/get-consumer-usage.md) - [Get speed test configuration](https://docs.xerobi.com/network-api/endpoint/get-speedtest-config.md) - [Xerobi Developer Documentation](https://docs.xerobi.com/index.md) - [RPKI API](https://docs.xerobi.com/rpki-api/introduction.md) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.