{"openapi":"3.0.0","info":{"title":"OVHcloud API specification","description":"Specification for OVHcloud API","version":"1.0","contact":{"name":"OVH","email":"api@ml.ovh.net"}},"servers":[{"url":"https://api.eu.ovhcloud.com/1.0"}],"components":{"schemas":{"any":{"description":"Can be anything (text, int, bool, json, html, etc.)","example":"This is a content of any type !"},"connectivity.eligibility.Address":{"type":"object","description":"Address","properties":{"building":{"type":"string","description":"Name of the building, if any","nullable":true,"readOnly":true},"city":{"type":"string","description":"City name","readOnly":true},"door":{"type":"string","description":"Identifier of the door, if any","nullable":true,"readOnly":true},"floor":{"type":"string","description":"Identifier of the floor, if any","nullable":true,"readOnly":true},"housingComplex":{"type":"string","description":"Name of the housing complex, if any","nullable":true,"readOnly":true},"inseeCode":{"type":"string","description":"INSEE code","readOnly":true},"ownerName":{"type":"string","description":"Owner name, this information can be restricted","nullable":true,"readOnly":true},"stairs":{"type":"string","description":"Identifier of the stair, if any","nullable":true,"readOnly":true},"streetCode":{"type":"string","description":"Street code, an unique identifier of the street, hidden for unlisted number","nullable":true,"readOnly":true},"streetName":{"type":"string","description":"Street name, hidden for unlisted number","nullable":true,"readOnly":true},"streetNumber":{"type":"string","description":"Street number, usually a number and an indication if applicable (B for bis, T for ter, etc...) and hidden for unlisted number","nullable":true,"readOnly":true},"zipCode":{"type":"string","description":"ZIP code","readOnly":true}}},"connectivity.eligibility.AddressWithCoordinates":{"type":"object","description":"Address with GPS coordinates","properties":{"buildingName":{"type":"string","description":"Building name","nullable":true,"readOnly":true},"buildingReference":{"type":"string","description":"Building reference","nullable":true,"readOnly":true},"city":{"type":"string","description":"City name","readOnly":true},"distance":{"type":"string","description":"Distance from original source, if applicable","nullable":true,"readOnly":true},"inseeCode":{"type":"string","description":"INSEE code","readOnly":true},"latitude":{"type":"string","description":"Latitude","readOnly":true},"longitude":{"type":"string","description":"Longitude","readOnly":true},"streetCode":{"type":"string","description":"Street code, an unique identifier of the street","nullable":true,"readOnly":true},"streetName":{"type":"string","description":"Street name","nullable":true,"readOnly":true},"streetNumber":{"type":"string","description":"Street number, usually a number and an indication if applicable (B for bis, T for ter, etc...) and hidden for unlisted number","nullable":true,"readOnly":true},"zipCode":{"type":"string","description":"ZIP code","readOnly":true}}},"connectivity.eligibility.Building":{"type":"object","description":"Details of a Building","properties":{"name":{"type":"string","description":"Building name","readOnly":true},"nro":{"type":"string","description":"Building NRO (Optical main distribution frame)","nullable":true,"readOnly":true},"reference":{"type":"string","description":"Identifier which refer to a building uniquely","readOnly":true},"stairs":{"type":"array","description":"Stairs for this building","nullable":true,"items":{"$ref":"#/components/schemas/connectivity.eligibility.BuildingStair"},"readOnly":true},"type":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.BuildingTypeEnum"}],"description":"Building type","nullable":true,"readOnly":true}}},"connectivity.eligibility.BuildingStair":{"type":"object","description":"Stair details of a Building","properties":{"floors":{"type":"array","description":"List of floor indentifier, \"_NA_\" if no identifier is available","items":{"type":"string"},"readOnly":true},"stair":{"type":"string","description":"Stair identifier, \"_NA_\" if no identifier is available","readOnly":true}}},"connectivity.eligibility.BuildingTypeEnum":{"type":"string","description":"Building type","enum":["BUILDING","HOUSE"]},"connectivity.eligibility.City":{"type":"object","description":"Represent a city","properties":{"city":{"type":"string","description":"Name of the city","readOnly":true},"inseeCode":{"type":"string","description":"INSEE code of the city","readOnly":true},"locality":{"type":"string","description":"Locality (subset of a city)","nullable":true,"readOnly":true},"zipCode":{"type":"string","description":"Zip code of the city","readOnly":true}}},"connectivity.eligibility.CopperInfo":{"type":"object","description":"Copper information","properties":{"availablePairs":{"type":"integer","description":"Number of available pairs. This is given only for an eligibility test.","nullable":true,"readOnly":true},"maxAvailablePairs":{"type":"integer","description":"Number of maximun available pairs using desaturation. This is given only for an eligibility test.","nullable":true,"readOnly":true},"nra":{"type":"string","description":"NRA (\"Nœud de raccordement abonné\" in french) is an identifier of the building where is the Main Distribution Frames for the copper line. This is given only for an eligibility test.","nullable":true,"readOnly":true},"sectionsLengths":{"type":"array","description":"Sections lengths of the copper line. This is given only for an eligibility test.","items":{"$ref":"#/components/schemas/connectivity.eligibility.SectionLength"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.LineStatusEnum"}],"description":"Line status","readOnly":true},"underConstruction":{"type":"boolean","description":"Is the line under construction ? This is given only for an eligibility test.","nullable":true,"readOnly":true},"unlistedNumber":{"type":"boolean","description":"Is the number unlisted ? (\"sur liste rouge\" in french)","readOnly":true}}},"connectivity.eligibility.InstallationTypeEnum":{"type":"string","description":"Installation type, for fiber only","enum":["activate","activate_undefined","create","multiOtp"]},"connectivity.eligibility.Line":{"type":"object","description":"Copper line details","properties":{"address":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.Address"}],"description":"Address","readOnly":true},"copperInfo":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.CopperInfo"}],"description":"Copper information","readOnly":true},"lineNumber":{"type":"string","description":"Line number","readOnly":true}}},"connectivity.eligibility.LineStatusEnum":{"type":"string","description":"Line status","enum":["active","inactive"]},"connectivity.eligibility.MeetingCapacities":{"type":"object","description":"Represents meeting booking options","properties":{"eRdv":{"type":"boolean","description":"Whether or not it is possible to book a meeting online","readOnly":true},"phoneCall":{"type":"boolean","description":"Whether or not it is possible to be be called by phone to book a meeting","readOnly":true}}},"connectivity.eligibility.MeetingSlot":{"type":"object","description":"Represents a time slot for a meeting","properties":{"endDate":{"type":"string","description":"End date","format":"date-time","readOnly":true},"slotId":{"type":"string","description":"Represent a meeting id for a fiber collect operator","nullable":true,"readOnly":true},"startDate":{"type":"string","description":"Start date","format":"date-time","readOnly":true},"uiCode":{"type":"string","description":"An opaque string that represents an intervention unit","nullable":true,"readOnly":true}}},"connectivity.eligibility.Meetings":{"type":"object","description":"List of available meeting time slots","properties":{"canBookFakeMeeting":{"type":"boolean","description":"Whether or not it is possible to book a fake meeting","readOnly":true},"capacities":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.MeetingCapacities"}],"description":"Represents meeting booking options","readOnly":true},"meetingSlots":{"type":"array","description":"A time slot","items":{"$ref":"#/components/schemas/connectivity.eligibility.MeetingSlot"},"readOnly":true}}},"connectivity.eligibility.OfferProductTypeEnum":{"type":"string","description":"Offer product type","enum":["ADSL","FTTE","FTTH","FTTO","SDSL","VDSL"]},"connectivity.eligibility.OfferProductUnbundlingTypeEnum":{"type":"string","description":"Offer product unbundling type","enum":["full","partial"]},"connectivity.eligibility.SectionLength":{"type":"object","description":"Section length of a copper line","properties":{"diameter":{"type":"integer","description":"Diameter in millimeters of the copper line section","readOnly":true},"length":{"type":"integer","description":"Lenght in meters of the copper line section","readOnly":true}}},"connectivity.eligibility.Street":{"type":"object","description":"Details of a street","properties":{"streetAltCode":{"type":"string","description":"Street alternative code, a possible alternative identifier of the street","nullable":true,"readOnly":true},"streetCode":{"type":"string","description":"Street code, an unique identifier of the street","readOnly":true},"streetName":{"type":"string","description":"Street name","readOnly":true}}},"connectivity.eligibility.StreetNumberDetails":{"type":"object","description":"Details of a street number struct","properties":{"hexacle":{"type":"string","description":"Hexacle is a French unique identifier of the address","nullable":true,"readOnly":true},"number":{"type":"string","description":"Street number","readOnly":true}}},"connectivity.eligibility.TechnicalVisitTypeEnum":{"type":"string","description":"Technical Visit type","enum":["complex","simple"]},"connectivity.eligibility.search.Cities":{"type":"object","description":"Search cities","properties":{"zipCode":{"type":"string","description":"Zip code"}},"required":["zipCode"]},"connectivity.eligibility.search.addresses.post":{"type":"object","description":"connectivity.eligibility.search.addresses.post","properties":{"distance":{"type":"integer","description":"Distance in meters to search for from initial location (default is 10 meters)"},"latitude":{"type":"string","description":"Latitude"},"longitude":{"type":"string","description":"Longitude"}},"required":["latitude","longitude"]},"connectivity.eligibility.search.buildingDetails.post":{"type":"object","description":"Building details","properties":{"building":{"type":"string","description":"Building identifier, that can be found using /connectivity/eligibility/search/building* methods"},"forceProvider":{"type":"string","description":"If possible, force to use a particular provider repository"}},"required":["building"]},"connectivity.eligibility.search.buildings.post":{"type":"object","description":"connectivity.eligibility.search.buildings.post","properties":{"hexacle":{"type":"string","description":"Hexacle is a French unique identifier of the address (you can get it with POST /connectivity/eligibility/search/streetNumbers/details)"},"streetAltCode":{"type":"string","description":"A possible alternative identifier of the street (you can get it with POST /connectivity/eligibility/search/streets)"},"streetCode":{"type":"string","description":"Unique identifier of the street (you can get it with POST /connectivity/eligibility/search/streets)"},"streetNumber":{"type":"string","description":"Street number"}}},"connectivity.eligibility.search.buildingsByLine.post":{"type":"object","description":"connectivity.eligibility.search.buildingsByLine.post","properties":{"lineNumber":{"type":"string","description":"Line number"},"status":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.LineStatusEnum"}],"description":"Line status"}},"required":["lineNumber","status"]},"connectivity.eligibility.search.lines.post":{"type":"object","description":"connectivity.eligibility.search.lines.post","properties":{"ownerName":{"type":"string","description":"Owner name, at least the first three chars"},"streetCode":{"type":"string","description":"Street code, that can be found using /connectivity/eligibility/search/streets method"},"streetNumber":{"type":"string","description":"Street number, that can be found using /connectivity/eligibility/search/streetNumbers method"}},"required":["streetCode","streetNumber"]},"connectivity.eligibility.search.meetings.post":{"type":"object","description":"connectivity.eligibility.search.meetings.post","properties":{"eligibilityReference":{"type":"string","description":"Eligibility test reference"},"installationType":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.InstallationTypeEnum"}],"description":"Installation type, for fiber only"},"otp":{"type":"string","description":"Fill in this field with your OTP reference if you have one"},"planCode":{"type":"string","description":"Offer plan code"},"productCode":{"type":"string","description":"Choosen offer product code"},"siteCompanyName":{"type":"string","description":"Site company name, please use the name and firstname for an individual"},"technicalVisit":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.TechnicalVisitTypeEnum"}],"description":"Special case to ask a technical visit on Fiber installation"},"type":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.OfferProductTypeEnum"}],"description":"Offer product type"},"unbundlingType":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.OfferProductUnbundlingTypeEnum"}],"description":"Offer product unbundling type"}},"required":["eligibilityReference"]},"connectivity.eligibility.search.streetNumbers.details.post":{"type":"object","description":"connectivity.eligibility.search.streetNumbers.details.post","properties":{"streetAltCode":{"type":"string","description":"Street alternative code, a possible alternative identifier of the street"},"streetCode":{"type":"string","description":"Street code, an unique identifier of the street"}},"required":["streetCode"]},"connectivity.eligibility.search.streetNumbers.post":{"type":"object","description":"connectivity.eligibility.search.streetNumbers.post","properties":{"streetAltCode":{"type":"string","description":"Street alternative code, a possible alternative identifier of the street"},"streetCode":{"type":"string","description":"Street code, an unique identifier of the street"}},"required":["streetCode"]},"connectivity.eligibility.search.streets.post":{"type":"object","description":"connectivity.eligibility.search.streets.post","properties":{"inseeCode":{"type":"string","description":"French INSEE identifier (you can get it with POST /connectivity/eligibility/search/cities)"}},"required":["inseeCode"]},"duration":{"type":"string","description":"Duration (e.g., P1Y2M3DT4H6M9S)","example":"P1Y2M3DT4H6M9S"},"email":{"type":"string","description":"Email address (e.g., api@ml.ovh.net)","format":"email","example":"api@ml.ovh.net"},"internationalPhoneNumber":{"type":"string","description":"International phone number","format":"phone-number"},"ip":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipBlock":{"type":"string","description":"IP (v4 or v6) CIDR notation (e.g., 192.0.2.0/24)","format":"ip-block","example":"192.0.2.0/24"},"ipInterface":{"type":"string","description":"IP address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4":{"type":"string","description":"IPv4 address (e.g., 192.0.2.0)","format":"ipv4","example":"192.0.2.0"},"ipv4Block":{"type":"string","description":"IPv4 CIDR notation (e.g., 192.0.2.0/24)","format":"ipv4-block","example":"192.0.2.0/24"},"ipv6":{"type":"string","description":"IPv6 address (e.g., 2001:41d0:1:1994::1)","format":"ipv6","example":"2001:41d0:1:1994::1"},"ipv6Block":{"type":"string","description":"IPv6 CIDR notation (e.g., 2001:41d0::/128)","format":"ipv6-block","example":"2001:41d0::/128"},"macAddress":{"type":"string","description":"MAC address (e.g., 00:00:5e:00:53:01)","format":"mac-address","example":"00:00:5e:00:53:01"},"phoneNumber":{"type":"string","description":"Phone number","format":"phone-number"},"time":{"type":"string","description":"Time (e.g., 15:04:05)","format":"time","example":"15:04:05"},"xdsl.AsyncTaskArray_connectivity.eligibility.AddressWithCoordinates":{"type":"object","description":"xdsl.AsyncTaskArray_connectivity.eligibility.AddressWithCoordinates","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/connectivity.eligibility.AddressWithCoordinates"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.AsyncTaskArray_connectivity.eligibility.Building":{"type":"object","description":"xdsl.AsyncTaskArray_connectivity.eligibility.Building","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/connectivity.eligibility.Building"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.AsyncTaskArray_connectivity.eligibility.City":{"type":"object","description":"xdsl.AsyncTaskArray_connectivity.eligibility.City","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/connectivity.eligibility.City"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"readOnly":true}}},"xdsl.AsyncTaskArray_connectivity.eligibility.Line":{"type":"object","description":"xdsl.AsyncTaskArray_connectivity.eligibility.Line","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/connectivity.eligibility.Line"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.AsyncTaskArray_connectivity.eligibility.Street":{"type":"object","description":"xdsl.AsyncTaskArray_connectivity.eligibility.Street","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/connectivity.eligibility.Street"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.AsyncTaskArray_connectivity.eligibility.StreetNumberDetails":{"type":"object","description":"xdsl.AsyncTaskArray_connectivity.eligibility.StreetNumberDetails","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/connectivity.eligibility.StreetNumberDetails"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.AsyncTaskArray_string":{"type":"object","description":"xdsl.AsyncTaskArray_string","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"type":"array","nullable":true,"items":{"type":"string"},"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.AsyncTaskStatusEnum":{"type":"string","description":"AsyncTask status","enum":["error","ok","pending"]},"xdsl.AsyncTask_connectivity.eligibility.Building":{"type":"object","description":"xdsl.AsyncTask_connectivity.eligibility.Building","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.Building"}],"description":"Details of a Building","nullable":true,"readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}},"xdsl.AsyncTask_connectivity.eligibility.Meetings":{"type":"object","description":"xdsl.AsyncTask_connectivity.eligibility.Meetings","properties":{"error":{"type":"string","nullable":true,"readOnly":true},"result":{"allOf":[{"$ref":"#/components/schemas/connectivity.eligibility.Meetings"}],"description":"List of available meeting time slots","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/xdsl.AsyncTaskStatusEnum"}],"description":"AsyncTask status","readOnly":true}}}},"securitySchemes":{"oAuth2AuthCode":{"type":"oauth2","description":"Oauth2","x-client-id":"1bb9c7df371741c0","x-client-secret":"a5b4de870aca620d10fbf63cd18d205b","flows":{"authorizationCode":{"authorizationUrl":"https://auth.eu.ovhcloud.com/oauth2/authorize","tokenUrl":"https://auth.eu.ovhcloud.com/oauth2/token","scopes":{"account/all":"Manage your account","all":"Manage your whole account and all your services","services/all":"Manage your services lifecycle and billing"}}}}}},"paths":{"/connectivity/eligibility/search/addresses":{"post":{"operationId":"eligibilitySearchAddresses","summary":"Search the addresses near a location","description":"Returns, as an asynchronous task, the addresses around a GPS location with their coordinates, street code, building reference and distance. The search radius is 10 meters by default.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.addresses.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_connectivity.eligibility.AddressWithCoordinates"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@10"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.addresses.post\nresult = client.post(\"/connectivity/eligibility/search/addresses\",\n\tdistance = None, # Distance in meters to search for from initial location (default is 10 meters) (type: integer)\n\tlatitude = None, # Latitude (type: string)\n\tlongitude = None, # Longitude (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.addresses.post\n$result = $ovh->post(\"/connectivity/eligibility/search/addresses\", array(\n\tdistance => null, // Distance in meters to search for from initial location (default is 10 meters) (type: integer)\n\tlatitude => null, // Latitude (type: string)\n\tlongitude => null, // Longitude (type: string)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/buildingDetails":{"post":{"operationId":"getBuildingDetails","summary":"Get the details of a building","description":"Returns, as an asynchronous task, the name, type, NRO and stairs of a building given by its identifier. Get the identifier with the search/buildings calls.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.buildingDetails.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTask_connectivity.eligibility.Building"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@20"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.buildingDetails.post\nresult = client.post(\"/connectivity/eligibility/search/buildingDetails\",\n\tbuilding = None, # Building identifier, that can be found using /connectivity/eligibility/search/building* methods (type: string)\n\tforceProvider = None, # If possible, force to use a particular provider repository (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.buildingDetails.post\n$result = $ovh->post(\"/connectivity/eligibility/search/buildingDetails\", array(\n\tbuilding => null, // Building identifier, that can be found using /connectivity/eligibility/search/building* methods (type: string)\n\tforceProvider => null, // If possible, force to use a particular provider repository (type: string)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/buildings":{"post":{"operationId":"getBuildings","summary":"Search the buildings of an address","description":"Returns, as an asynchronous task, the buildings at an address with their reference, name, type, NRO and stairs. The address needs at least a street code and street number, or a Hexacle.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.buildings.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_connectivity.eligibility.Building"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@30"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.buildings.post\nresult = client.post(\"/connectivity/eligibility/search/buildings\",\n\thexacle = None, # Hexacle is a French unique identifier of the address (you can get it with POST /connectivity/eligibility/search/streetNumbers/details) (type: string)\n\tstreetAltCode = None, # A possible alternative identifier of the street (you can get it with POST /connectivity/eligibility/search/streets) (type: string)\n\tstreetCode = None, # Unique identifier of the street (you can get it with POST /connectivity/eligibility/search/streets) (type: string)\n\tstreetNumber = None, # Street number (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.buildings.post\n$result = $ovh->post(\"/connectivity/eligibility/search/buildings\", array(\n\thexacle => null, // Hexacle is a French unique identifier of the address (you can get it with POST /connectivity/eligibility/search/streetNumbers/details) (type: string)\n\tstreetAltCode => null, // A possible alternative identifier of the street (you can get it with POST /connectivity/eligibility/search/streets) (type: string)\n\tstreetCode => null, // Unique identifier of the street (you can get it with POST /connectivity/eligibility/search/streets) (type: string)\n\tstreetNumber => null, // Street number (type: string)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/buildingsByLine":{"post":{"operationId":"getBuildingsByLine","summary":"Search the buildings of a line number","description":"Returns, as an asynchronous task, the buildings linked to a line number and its status, with their reference, name, type, NRO and stairs.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.buildingsByLine.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_connectivity.eligibility.Building"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@40"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.buildingsByLine.post\nresult = client.post(\"/connectivity/eligibility/search/buildingsByLine\",\n\tlineNumber = None, # Line number (type: string)\n\tstatus = None, # Line status (type: connectivity.eligibility.LineStatusEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.buildingsByLine.post\n$result = $ovh->post(\"/connectivity/eligibility/search/buildingsByLine\", array(\n\tlineNumber => null, // Line number (type: string)\n\tstatus => null, // Line status (type: connectivity.eligibility.LineStatusEnum)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/cities":{"post":{"operationId":"getCities","summary":"Search the localities of a zip code","description":"Returns, as an asynchronous task, the cities and localities linked to a zip code with their INSEE code. Use the INSEE code to search the streets of a locality.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.Cities"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_connectivity.eligibility.City"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@50"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.Cities\nresult = client.post(\"/connectivity/eligibility/search/cities\",\n\tzipCode = None, # Zip code (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.Cities\n$result = $ovh->post(\"/connectivity/eligibility/search/cities\", array(\n\tzipCode => null, // Zip code (type: string)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/lines":{"post":{"operationId":"getLines","summary":"Search the lines at an address","description":"**Deprecated**: this endpoint is scheduled for deletion. Returns, as an asynchronous task, the inactive copper lines at an address, and the active ones when the owner name is given (at least its first three characters).","deprecated":true,"x-deprecation-date":"2026-04-08T00:00:00Z","x-deletion-date":"2026-07-08T00:00:00Z","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.lines.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_connectivity.eligibility.Line"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@60"]],"x-badges":[{"color":"red","label":"Deprecated, will be removed"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.lines.post\nresult = client.post(\"/connectivity/eligibility/search/lines\",\n\townerName = None, # Owner name, at least the first three chars (type: string)\n\tstreetCode = None, # Street code, that can be found using /connectivity/eligibility/search/streets method (type: string)\n\tstreetNumber = None, # Street number, that can be found using /connectivity/eligibility/search/streetNumbers method (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.lines.post\n$result = $ovh->post(\"/connectivity/eligibility/search/lines\", array(\n\townerName => null, // Owner name, at least the first three chars (type: string)\n\tstreetCode => null, // Street code, that can be found using /connectivity/eligibility/search/streets method (type: string)\n\tstreetNumber => null, // Street number, that can be found using /connectivity/eligibility/search/streetNumbers method (type: string)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/meetings":{"post":{"operationId":"getMeetings","summary":"Search the installation meeting slots","description":"Returns, as an asynchronous task, the available time slots for a copper line creation or a fiber installation meeting, for an eligibility test reference and a chosen offer.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.meetings.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTask_connectivity.eligibility.Meetings"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@70"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.meetings.post\nresult = client.post(\"/connectivity/eligibility/search/meetings\",\n\teligibilityReference = None, # Eligibility test reference (type: string)\n\tinstallationType = None, # Installation type, for fiber only (type: connectivity.eligibility.InstallationTypeEnum)\n\totp = None, # Fill in this field with your OTP reference if you have one (type: string)\n\tplanCode = None, # Offer plan code (type: string)\n\tproductCode = None, # Choosen offer product code (type: string)\n\tsiteCompanyName = None, # Site company name, please use the name and firstname for an individual (type: string)\n\ttechnicalVisit = None, # Special case to ask a technical visit on Fiber installation (type: connectivity.eligibility.TechnicalVisitTypeEnum)\n\ttype = None, # Offer product type (type: connectivity.eligibility.OfferProductTypeEnum)\n\tunbundlingType = None, # Offer product unbundling type (type: connectivity.eligibility.OfferProductUnbundlingTypeEnum)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.meetings.post\n$result = $ovh->post(\"/connectivity/eligibility/search/meetings\", array(\n\teligibilityReference => null, // Eligibility test reference (type: string)\n\tinstallationType => null, // Installation type, for fiber only (type: connectivity.eligibility.InstallationTypeEnum)\n\totp => null, // Fill in this field with your OTP reference if you have one (type: string)\n\tplanCode => null, // Offer plan code (type: string)\n\tproductCode => null, // Choosen offer product code (type: string)\n\tsiteCompanyName => null, // Site company name, please use the name and firstname for an individual (type: string)\n\ttechnicalVisit => null, // Special case to ask a technical visit on Fiber installation (type: connectivity.eligibility.TechnicalVisitTypeEnum)\n\ttype => null, // Offer product type (type: connectivity.eligibility.OfferProductTypeEnum)\n\tunbundlingType => null, // Offer product unbundling type (type: connectivity.eligibility.OfferProductUnbundlingTypeEnum)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/streetNumbers":{"post":{"operationId":"getStreetNumbers","summary":"Search the numbers of a street","description":"Returns, as an asynchronous task, the available street numbers of a street given by its street code. Get the street code with search/streets.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.streetNumbers.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_string"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@80"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.streetNumbers.post\nresult = client.post(\"/connectivity/eligibility/search/streetNumbers\",\n\tstreetAltCode = None, # Street alternative code, a possible alternative identifier of the street (type: string)\n\tstreetCode = None, # Street code, an unique identifier of the street (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.streetNumbers.post\n$result = $ovh->post(\"/connectivity/eligibility/search/streetNumbers\", array(\n\tstreetAltCode => null, // Street alternative code, a possible alternative identifier of the street (type: string)\n\tstreetCode => null, // Street code, an unique identifier of the street (type: string)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/streetNumbers/details":{"post":{"operationId":"getStreetNumbersDetails","summary":"Search the numbers of a street with their details","description":"Returns, as an asynchronous task, the available street numbers of a street given by its street code, each with its Hexacle address identifier. Get the street code with search/streets.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.streetNumbers.details.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_connectivity.eligibility.StreetNumberDetails"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@90"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.streetNumbers.details.post\nresult = client.post(\"/connectivity/eligibility/search/streetNumbers/details\",\n\tstreetAltCode = None, # Street alternative code, a possible alternative identifier of the street (type: string)\n\tstreetCode = None, # Street code, an unique identifier of the street (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.streetNumbers.details.post\n$result = $ovh->post(\"/connectivity/eligibility/search/streetNumbers/details\", array(\n\tstreetAltCode => null, // Street alternative code, a possible alternative identifier of the street (type: string)\n\tstreetCode => null, // Street code, an unique identifier of the street (type: string)\n));\n\nprint_r($result);\n?>"}]}},"/connectivity/eligibility/search/streets":{"post":{"operationId":"getStreets","summary":"Search the streets of a locality","description":"Returns, as an asynchronous task, the streets of a locality given by its INSEE code, with their name, street code and alternative code. Get the INSEE code with search/cities.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/connectivity.eligibility.search.streets.post"}}}},"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/xdsl.AsyncTaskArray_connectivity.eligibility.Street"}}}}},"x-developer-hub-navigation":[["Web Cloud","Internet","Eligibility","Search@@@100"]],"x-badges":[{"color":"green","label":"Stable production version"}],"x-code-samples":[{"lang":"python","label":"Python","source":"'''\nFirst, install the latest release of Python wrapper: $ pip install ovh\n'''\nimport json\nimport ovh\n\n# Instantiate an OVH Client.\n# You can generate new credentials with full access to your account on\n# the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\nclient = ovh.Client(\n\tendpoint='ovh-eu',               # Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n\tapplication_key='xxxxxxxxxx',    # Application Key\n\tapplication_secret='xxxxxxxxxx', # Application Secret\n\tconsumer_key='xxxxxxxxxx',       # Consumer Key\n)\n\n# Request body type: connectivity.eligibility.search.streets.post\nresult = client.post(\"/connectivity/eligibility/search/streets\",\n\tinseeCode = None, # French INSEE identifier (you can get it with POST /connectivity/eligibility/search/cities) (type: string)\n)\n\n# Pretty print\nprint(json.dumps(result, indent=4))"},{"lang":"php","label":"PHP","source":"<?php\n/**\n * First, download the latest release of PHP wrapper on github\n * And include this script into the folder with extracted files\n */\nrequire __DIR__ . '/vendor/autoload.php';\nuse \\Ovh\\Api;\n\n/**\n * Instantiate an OVH Client.\n * You can generate new credentials with full access to your account on\n * the token creation page (https://api.ovh.com/createToken/index.cgi?GET=/*&PUT=/*&POST=/*&DELETE=/*)\n */\n$ovh = new Api('xxxxxxxxxx',  // Application Key\n               'xxxxxxxxxx',  // Application Secret\n               'ovh-eu',      // Endpoint of API OVH (List of available endpoints: https://github.com/ovh/python-ovh#2-configure-your-application)\n               'xxxxxxxxxx'); // Consumer Key\n\n// Request body type: connectivity.eligibility.search.streets.post\n$result = $ovh->post(\"/connectivity/eligibility/search/streets\", array(\n\tinseeCode => null, // French INSEE identifier (you can get it with POST /connectivity/eligibility/search/cities) (type: string)\n));\n\nprint_r($result);\n?>"}]}}}}