{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"cd63154f-49cf-4a36-baa2-108485651f99","name":"VETRO FiberMap API","description":"# Welcome!\n\n**VETRO FiberMap®** uses a RESTful API to interact with its underlying data structure. It utilizes standard HTTP requests and, whenever applicable, accepts _application/json_ requests and responds with JSON objects.\n\n### OpenAPI\n\nThe API is built following the OpenAPI 3.0 specification.  A yaml file describing the API can be downloaded [here](https://fibermap.vetro.io/vetro_apis.yaml).\n\n### Making Requests\n\n**VETRO FiberMap** uses HTTP requests and mostly adheres to the idea of RESTful verbs to send and retrieve data. Authentication and authorization for requests is handled via basic HTTP authentication using either login sessions or access tokens (<a href=\"#token-access\">See below</a>).\n\nGET or DELETE requests will usually include _required_ data as parameters as part of the URL address. For example, retrieving information around a specific location may require the location's latitude and longitude, as in _/api/layer/geometriesNear/-73.45/44.2341_.\n\nOptional parameters will usually use a querystring key/value parameter after the URL. For example, the previous request uses a default search radius of 50 meters, but you can change that value by include a query parameter, like this: _/api/layer/geometriesNear/-73.45/44.2341?radius=100_. All optional parameters are described in the documentation for each API endpoint.\n\nAll POST requests should use the header `Content-type: application/json` along with any required data using a raw JSON-formatted body. POST requests do not generally accept _form_ style key-value requests.\n\n### Output Formats\n\nAlmost all APIs return JSON data, nearly always following this format:\n\n```js\n{\n  \"success\": true,\n  \"result\": (data)\n}\n```\n\n`(data)` will be whatever you're asking for: the identity of a object on your network, or a set of utility poles, for instance. It may be as simple as a boolean indicating whether an operation did what you asked.\n\nFailures will normally respond with a non-200 error code, usually `400` for errors in the request, or `500` for internal issues.\n\n### Asynchronous Jobs\n\n```js\n> POST /api/(async endpoint) HTTP/1.1\n> Host: vetro.io\n> Content-type: application/json\n> Content-Length: 12345\n...\n\nResult:\n{\n  \"success\": true,\n  \"result\": {\n    \"status\": \"started\",\n    \"id\": \"status_id_uuid\",\n    \"resultsURL\": \"/api/(async endpoint)/status/status_id_uuid\",\n  }\n}\n\n> GET /api/(async endpoint)/status/status_id_uuid\n\nResult:\n{\n  \"success\": true,\n  \"result\": {\n    \"status\": \"in progress\",\n    \"detail\": \"Done with part X\",\n    \"id\": \"status_id_uuid\",\n    \"resultsURL\": \"/api/(async endpoint)/status/status_id_uuid\",\n  }\n}\n\n> GET /api/(async endpoint)/status/status_id_uuid\n\nResult:\n{\n  \"success\": true,\n  \"result\": {\n    \"status\": \"complete\",\n    \"id\": \"status_id_uuid\",\n    \"resultsURL\": \"/api/(async endpoint)/results/status_id_uuid\",\n  }\n}\n\n> GET /api/(async endpoint)/results/status_id_uuid\n\n(Retrieves the results, whether a .zip file, .csv or anything else, depending on the endpoint!)\n```\n\nCertain endpoints refer to _Asynchronous Jobs_ and do not return immediate results. These are generally used for long-running or complex requests that cannot be handled within the timeframe of a normal HTTP request.\n\nInstead, **VETRO FiberMap** enables job-based requests that return an immediate \"accepted\" response that includes a _status_ URL. That URL should be used to periodically check the runtime status of the asynchronous job - usually there will be \"progress reports\" along the way, explaining that the job is underway, waiting for some further processing, or complete.\n\nOnce complete, that status URL will return a _response_ URL that should be used to retrieve the results of the initial request.\n\nFollow along with the example to the right.\n\n### Usage Limits\n\nSome **VETRO FiberMap** API endpoints require some more intensive server processing. In these cases, there will be usage limits applied. If you hit these API endpoints too many times within a certain timespan, the API endpoint will return a `429` error code, with messaging similar to:\n`\"Too many requests per second, please slow down the number of concurrent requests.\"`\n\n### Other Notes\n\n- Many **VETRO FiberMap** APIs return ID values. Those ID values can often be used to make further requests, and we do our best to maintain the names of parameters so that subsequent uses should be apparent. For example, an early request may present a list of information about different available datasets and each includes a `layer_id` value. Searching for other endpoints that offer `layer_id` as an input parameter can give you hints where to use it.\n\n### Support\n\n**Please note** that this public API is provided for your use in accessing your network and related non-network data. While we are happy to assist you in understanding the parameters that go into requests to this API or the answers that result, we can provide only advisory support for whatever application is using this data other than **VETRO FiberMap**.\n\nPlease contact us through support@vetrofibermap.com if you have any questions or concerns!\n\n\nThis documentation was generated on Thu, 17 Jun 2021 18:11:08 GMT.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"11528456","team":1088250,"collectionId":"cd63154f-49cf-4a36-baa2-108485651f99","publishedId":"2sAYX5MiJt","public":true,"publicUrl":"https://vetro-fiber-map.etisoftware.com","privateUrl":"https://go.postman.co/documentation/11528456-cd63154f-49cf-4a36-baa2-108485651f99","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":null,"colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"FF6C37"}},{"name":"light","logo":null,"colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"}}]}},"version":"8.10.0","publishDate":"2025-02-04T18:27:56.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":null,"logoDark":null}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/52de83af874f462001674ddb9bdc1bfca2ae7a02c72a76650e1d6907bc6253c0","favicon":"https://etisoftware.com/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://vetro-fiber-map.etisoftware.com/view/metadata/2sAYX5MiJt"}