Skip to navigation
API ReferenceCoverage

Get Shared Circuit Coverage

View as Markdown

Retrieve shared-access circuit coverage for the specified address. The optional technology filter accepts the aliases normalized by the API.

Query parameters

streetEgonstringRequired
The EGON code of the street
mainEgonstringRequired
The EGON code of the main connection point
streetNumberstringRequired
The street number
technologyenumOptional
Optional technology filter. If omitted, all shared technologies are returned.
Allowed values:

Response

Shared circuit coverage retrieved successfully.
providerIdinteger
The provider identifier
providerNamestring
The provider name
speedLimitfloat
The maximum available speed
multipleConnectionboolean
Whether multiple connections are available
distancefloat
The distance from the connection element
connectionTypestring
The connection type
connectionElementNamestring
The connection element name
connectionCLListring
The connection CLLI code
serviceNamestring
The service name
serviceDescriptionstring
The service description
oloServiceIdinteger
The OLO service identifier
oloTypeProductstring
The OLO product type
oloTypeServicestring
The OLO service type
coverageboolean
Whether coverage is available
idBuildingstring
The building identifier
headerIdstring
The header identifier
connectionElementDetailstring
The connection element detail
speedCompletestring or nullOptional
The complete speed description
fiberRangestring or nullOptional
The fiber range, if available
statusCodestring or nullOptional
Provider status code, when returned
statusDescriptionstring or nullOptional
Provider status description, when returned

Errors

400
Bad Request Error
500
Internal Server Error