{ "openapi": "3.0.4", "info": { "title": "CDXGeoData REST API", "description": "GeoData API v1", "version": "v1" }, "paths": { "/api/v1/geogeneral": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. and Canadian Postal Code data including city, county, state, latitude, and longitude.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US or Canadian postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geogeneral": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. and Canadian Postal Code data including city, county, state, latitude, and longitude.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US or Canadian postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/georace": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. ZIP Code population statistics for race based on Census 2010 ZIP Code Tabulation Areas.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/georace": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. ZIP Code population statistics for race based on Census 2010 ZIP Code Tabulation Areas.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geodemographics": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. ZIP Code demographics covering population, income, housing, and more.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geodemographics": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. ZIP Code demographics covering population, income, housing, and more.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geogender": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. ZIP Code population statistics for gender based on Census 2010 ZIP Code Tabulation Areas.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geogender": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. ZIP Code population statistics for gender based on Census 2010 ZIP Code Tabulation Areas.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geoziplistcity": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get a complete list of U.S. ZIP Codes for a given city, county, or state. City, county, and state data associated with each ZIP Code are also provided.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "county", "in": "query", "description": "US county", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "US city", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geoziplistcity": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get a complete list of U.S. ZIP Codes for a given city, county, or state. City, county, and state data associated with each ZIP Code are also provided.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "county", "in": "query", "description": "US county", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "US city", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geoziplistcounty": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get a complete list of U.S. ZIP Codes for a given city, county, or state. City, county, and state data associated with each ZIP Code are also provided.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "county", "in": "query", "description": "US county", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geoziplistcounty": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get a complete list of U.S. ZIP Codes for a given city, county, or state. City, county, and state data associated with each ZIP Code are also provided.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "county", "in": "query", "description": "US county", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geozipliststate": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get a complete list of U.S. ZIP Codes for a given city, county, or state. City, county, and state data associated with each ZIP Code are also provided.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geozipliststate": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get a complete list of U.S. ZIP Codes for a given city, county, or state. City, county, and state data associated with each ZIP Code are also provided.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geofindzip": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "List all U.S. ZIP Codes associated with any city/state combination.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "US city", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geofindzip": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "List all U.S. ZIP Codes associated with any city/state combination.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "US state", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "US city", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/georadius": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Generate a list of all U.S. ZIP Codes up to a radius distance of 200 miles around a central target ZIP Code. Also obtain latitude, longitude, and distance from the target for each ZIP Code in the radius area.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "mileage", "in": "query", "description": "Size of radius in miles", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "description": "Distance Measurement", "schema": { "type": "string", "default": "miles" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/georadius": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Generate a list of all U.S. ZIP Codes up to a radius distance of 200 miles around a central target ZIP Code. Also obtain latitude, longitude, and distance from the target for each ZIP Code in the radius area.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "mileage", "in": "query", "description": "Size of radius in miles", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "description": "Distance Measurement", "schema": { "type": "string", "default": "miles" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geodistance": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate the straight-line (as-the-crow-flies) distance between U.S. ZIP Codes. Calculations use the centroid point of each ZIP Code area. Distance is provided in miles, kilometers, or nautical miles.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode1", "in": "query", "description": "1st US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode2", "in": "query", "description": "2nd US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "schema": { "type": "string", "default": "miles" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geodistance": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate the straight-line (as-the-crow-flies) distance between U.S. ZIP Codes. Calculations use the centroid point of each ZIP Code area. Distance is provided in miles, kilometers, or nautical miles.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode1", "in": "query", "description": "1st US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "zipCode2", "in": "query", "description": "2nd US postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "schema": { "type": "string", "default": "miles" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geoverify": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Perform address verification and correction using U.S. Postal Service databases. Get address data in standard format and find ZIP+4 Codes even for addresses with missing data.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Street Address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "cityStateZip", "in": "query", "description": "City, State and optional Zip code (separated by commas)", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geoverify": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Perform address verification and correction using U.S. Postal Service databases. Get address data in standard format and find ZIP+4 Codes even for addresses with missing data.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Street Address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "cityStateZip", "in": "query", "description": "City, State and optional Zip code (separated by commas)", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geoverifysingle": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Perform address verification and correction using U.S. Postal Service databases. Get address data in standard format and find ZIP+4 Codes even for addresses with missing data.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Street Address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "delimiter", "in": "query", "description": "Character used to concatenate full address data into address,city,state,zip", "schema": { "type": "string", "default": "," } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geoverifysingle": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Perform address verification and correction using U.S. Postal Service databases. Get address data in standard format and find ZIP+4 Codes even for addresses with missing data.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Street Address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "delimiter", "in": "query", "description": "Character used to concatenate full address data into address,city,state,zip", "schema": { "type": "string", "default": "," } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geotract": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. Census Tract demographics covering population, income, housing, and more.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "id", "in": "query", "description": "Census Tract (GEOID)", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geotract": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get U.S. Census Tract demographics covering population, income, housing, and more.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "id", "in": "query", "description": "Census Tract (GEOID)", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/canadian/geogeneral": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get Canadian Postal Code data including city, county, state, latitude, and longitude.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "postalCode", "in": "query", "description": "Canadian Postal Code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/canadian/geogeneral": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Get Canadian Postal Code data including city, county, state, latitude, and longitude.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "postalCode", "in": "query", "description": "Canadian Postal Code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/canadian/georadius": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Generate a list of all Canadian Postal Codes up to a radius distance of 200 miles around a central target Postal Code. Also obtain latitude, longitude, and distance from the target for each Postal Code in the radius area.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "postalCode", "in": "query", "description": "Canadian postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "mileage", "in": "query", "description": "Size of radius in miles", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "description": "Distance Measurement", "schema": { "type": "string", "default": "miles" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/canadian/georadius": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Generate a list of all Canadian Postal Codes up to a radius distance of 200 miles around a central target Postal Code. Also obtain latitude, longitude, and distance from the target for each Postal Code in the radius area.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "postalCode", "in": "query", "description": "Canadian postal code", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "mileage", "in": "query", "description": "Size of radius in miles", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "description": "Distance Measurement", "schema": { "type": "string", "default": "miles" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/georoute": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from Bing Maps with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "routeStart", "in": "query", "description": "Starting point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "routeEnd", "in": "query", "description": "Ending point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "travelMode", "in": "query", "schema": { "type": "string", "default": "driving" } }, { "name": "optimize", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "schema": { "type": "string", "default": "mi" } }, { "name": "avoidOptions", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitDateTime", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitTimeMode", "in": "query", "schema": { "type": "string", "default": "departure" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/georoute": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from Bing Maps with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "routeStart", "in": "query", "description": "Starting point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "routeEnd", "in": "query", "description": "Ending point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "travelMode", "in": "query", "schema": { "type": "string", "default": "driving" } }, { "name": "optimize", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "schema": { "type": "string", "default": "mi" } }, { "name": "avoidOptions", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitDateTime", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitTimeMode", "in": "query", "schema": { "type": "string", "default": "departure" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/georoutepoint": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from Bing Maps with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "wayPoints", "in": "query", "description": "List of points, landmarks, or addresses (max of 25)", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "travelMode", "in": "query", "schema": { "type": "string", "default": "driving" } }, { "name": "optimize", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "schema": { "type": "string", "default": "mi" } }, { "name": "avoidOptions", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitDateTime", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitTimeMode", "in": "query", "schema": { "type": "string", "default": "departure" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/georoutepoint": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from Bing Maps with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "wayPoints", "in": "query", "description": "List of points, landmarks, or addresses (max of 25)", "required": true, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "travelMode", "in": "query", "schema": { "type": "string", "default": "driving" } }, { "name": "optimize", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "distanceUnit", "in": "query", "schema": { "type": "string", "default": "mi" } }, { "name": "avoidOptions", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitDateTime", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "transitTimeMode", "in": "query", "schema": { "type": "string", "default": "departure" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geolocate": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Bing Maps, which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geolocate": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Bing Maps, which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geolocatepoint": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Bing Maps, which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "latitude", "in": "query", "description": "Latitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "longitude", "in": "query", "description": "Longitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geolocatepoint": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Bing Maps, which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "latitude", "in": "query", "description": "Latitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "longitude", "in": "query", "description": "Longitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geolocateaddress": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Bing Maps, which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Full or partial address data", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "City", "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "State", "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "Zip Code", "schema": { "type": "string", "default": "" } }, { "name": "country", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geolocateaddress": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Bing Maps, which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Full or partial address data", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "City", "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "State", "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "description": "Zip Code", "schema": { "type": "string", "default": "" } }, { "name": "country", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/census/geolocate": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) Data is sourced from the U.S. Census Bureau.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "street", "in": "query", "description": "Street address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "City", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "State", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "benchmark", "in": "query", "schema": { "type": "string", "default": "current" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/census/geolocate": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) Data is sourced from the U.S. Census Bureau.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "street", "in": "query", "description": "Street address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "City", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "State", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "benchmark", "in": "query", "schema": { "type": "string", "default": "current" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/census/geolocate/single": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) Data is sourced from the U.S. Census Bureau.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Full or partial street address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "benchmark", "in": "query", "schema": { "type": "string", "default": "current" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/census/geolocate/single": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) Data is sourced from the U.S. Census Bureau.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Full or partial street address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "benchmark", "in": "query", "schema": { "type": "string", "default": "current" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geocode/here": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Full street address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "City", "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "State", "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "country", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geocode/here": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Full street address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "description": "City", "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "description": "State", "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "country", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geocode/here/single": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Full or partial address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geocode/here/single": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Full or partial address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geocode/here/reverse": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "latitude", "in": "query", "description": "Latitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "longitude", "in": "query", "description": "LongitudeCoordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geocode/here/reverse": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from HERE Technologies which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "latitude", "in": "query", "description": "Latitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "longitude", "in": "query", "description": "LongitudeCoordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/georoute/here": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from HERE Technologies with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "transportMode", "in": "query", "description": "Transportation Mode", "schema": { "type": "string", "default": "car" } }, { "name": "routingMode", "in": "query", "schema": { "type": "string", "default": "fast" } }, { "name": "origin", "in": "query", "description": "Starting point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "destination", "in": "query", "description": "Ending point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "geocode", "in": "query", "description": "Geocode option", "schema": { "type": "boolean", "default": false } }, { "name": "wayPoints", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/georoute/here": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from HERE Technologies with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "transportMode", "in": "query", "description": "Transportation Mode", "schema": { "type": "string", "default": "car" } }, { "name": "routingMode", "in": "query", "schema": { "type": "string", "default": "fast" } }, { "name": "origin", "in": "query", "description": "Starting point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "destination", "in": "query", "description": "Ending point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "geocode", "in": "query", "description": "Geocode option", "schema": { "type": "boolean", "default": false } }, { "name": "wayPoints", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geocode/google": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Google Maps Platform which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Full or partial address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "country", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geocode/google": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Google Maps Platform which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "address", "in": "query", "description": "Full or partial address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "city", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "state", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "zipCode", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "country", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geocode/google/single": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Google Maps Platform which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Full or partial address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geocode/google/single": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Google Maps Platform which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "query", "in": "query", "description": "Full or partial address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/geocode/google/reverse": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Google Maps Platform which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "latitude", "in": "query", "description": "Latitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "longitude", "in": "query", "description": "Longitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/geocode/google/reverse": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Geocode (get latitude and longitude from addresses) and reverse geocode (get addresses from latitude and longitude). Data is sourced from Google Maps Platform which provide address or rooftop geocoding precision.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "latitude", "in": "query", "description": "Latitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "longitude", "in": "query", "description": "Longitude Coordinate", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/georoute/google": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from Google Maps Platform with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "travelMode", "in": "query", "description": "Transportation Mode", "schema": { "type": "string", "default": "DRIVE" } }, { "name": "origin", "in": "query", "description": "Starting point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "destination", "in": "query", "description": "Ending point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "wayPoints", "in": "query", "description": "Optional list of stops to make along the route", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/georoute/google": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Calculate travel (driving) distance and time using routing data from Google Maps Platform with worldwide routing and rooftop geocoding. Driving, Walking, Transit and other travel modes are supported.", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "travelMode", "in": "query", "description": "Transportation Mode", "schema": { "type": "string", "default": "DRIVE" } }, { "name": "origin", "in": "query", "description": "Starting point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "destination", "in": "query", "description": "Ending point, landmark, or address", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "wayPoints", "in": "query", "description": "Optional list of stops to make along the route", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/utility/tokenusage": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Returns token usage for the specified Api key", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "details", "in": "query", "description": "If truthy, returns usage details", "schema": { "type": "string", "default": "0" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/utility/tokenusage": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Returns token usage for the specified Api key", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "details", "in": "query", "description": "If truthy, returns usage details", "schema": { "type": "string", "default": "0" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/utility/servicelist": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Returns a complete list of available Api services", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "serviceName", "in": "query", "description": "When specified only details of the named service will be returned", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/utility/servicelist": { "get": { "tags": [ "CDXGeoData V1" ], "summary": "Returns a complete list of available Api services", "parameters": [ { "name": "key", "in": "query", "description": "Your API key", "required": true, "schema": { "type": "string", "default": "" } }, { "name": "serviceName", "in": "query", "description": "When specified only details of the named service will be returned", "schema": { "type": "string", "default": "" } }, { "name": "format", "in": "query", "description": "", "schema": { "type": "string", "default": "json" } } ], "responses": { "200": { "description": "OK" } } } } }, "components": { } }