getAddressByCoordinatesPost
Convert a location`s coordinates on the map to an address string.
/getAddressByCoordinates
Usage and SDK Samples
curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/yandexgeocode/getAddressByCoordinates?coordinates=&searchAreaRestriction=¢erMap=&orderCoordinates=&results=&language=&toponymType=&searchAreaSize="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.GetAddressByCoordinatesApi;
import java.io.File;
import java.util.*;
public class GetAddressByCoordinatesApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: apieco-key
ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
apieco-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.setApiKeyPrefix("Token");
GetAddressByCoordinatesApi apiInstance = new GetAddressByCoordinatesApi();
String apiecoKey = apiecoKey_example; // String |
String coordinates = coordinates_example; // String | The latitude and longitude of the find place
String searchAreaRestriction = searchAreaRestriction_example; // String | A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter.
String centerMap = centerMap_example; // String | Longitude and latitude of the center of the map in degrees.
String orderCoordinates = orderCoordinates_example; // String | The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude.
BigDecimal results = 8.14; // BigDecimal | Number of objects returned. The default is 10. The maximum allowable value is 500.
String language = language_example; // String | Preferred response language.Example - en_RU.
String toponymType = toponymType_example; // String | Kind of toponym.
String searchAreaSize = searchAreaSize_example; // String | The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552;
try {
geo result = apiInstance.getAddressByCoordinatesPost(apiecoKey, coordinates, searchAreaRestriction, centerMap, orderCoordinates, results, language, toponymType, searchAreaSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GetAddressByCoordinatesApi#getAddressByCoordinatesPost");
e.printStackTrace();
}
}
}
import io.swagger.client.api.GetAddressByCoordinatesApi;
public class GetAddressByCoordinatesApiExample {
public static void main(String[] args) {
GetAddressByCoordinatesApi apiInstance = new GetAddressByCoordinatesApi();
String apiecoKey = apiecoKey_example; // String |
String coordinates = coordinates_example; // String | The latitude and longitude of the find place
String searchAreaRestriction = searchAreaRestriction_example; // String | A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter.
String centerMap = centerMap_example; // String | Longitude and latitude of the center of the map in degrees.
String orderCoordinates = orderCoordinates_example; // String | The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude.
BigDecimal results = 8.14; // BigDecimal | Number of objects returned. The default is 10. The maximum allowable value is 500.
String language = language_example; // String | Preferred response language.Example - en_RU.
String toponymType = toponymType_example; // String | Kind of toponym.
String searchAreaSize = searchAreaSize_example; // String | The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552;
try {
geo result = apiInstance.getAddressByCoordinatesPost(apiecoKey, coordinates, searchAreaRestriction, centerMap, orderCoordinates, results, language, toponymType, searchAreaSize);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling GetAddressByCoordinatesApi#getAddressByCoordinatesPost");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];
String *apiecoKey = apiecoKey_example; //
String *coordinates = coordinates_example; // The latitude and longitude of the find place
String *searchAreaRestriction = searchAreaRestriction_example; // A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter. (optional)
String *centerMap = centerMap_example; // Longitude and latitude of the center of the map in degrees. (optional)
String *orderCoordinates = orderCoordinates_example; // The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude. (optional)
BigDecimal *results = 8.14; // Number of objects returned. The default is 10. The maximum allowable value is 500. (optional)
String *language = language_example; // Preferred response language.Example - en_RU. (optional)
String *toponymType = toponymType_example; // Kind of toponym. (optional)
String *searchAreaSize = searchAreaSize_example; // The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552; (optional)
GetAddressByCoordinatesApi *apiInstance = [[GetAddressByCoordinatesApi alloc] init];
// Convert a location`s coordinates on the map to an address string.
[apiInstance getAddressByCoordinatesPostWith:apiecoKey
coordinates:coordinates
searchAreaRestriction:searchAreaRestriction
centerMap:centerMap
orderCoordinates:orderCoordinates
results:results
language:language
toponymType:toponymType
searchAreaSize:searchAreaSize
completionHandler: ^(geo output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error: %@", error);
}
}];
var YandexGeocoder_ = require('yandex_geocoder__');
var defaultClient = YandexGeocoder_.ApiClient.instance;
// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"
var api = new YandexGeocoder_.GetAddressByCoordinatesApi()
var apiecoKey = apiecoKey_example; // {String}
var coordinates = coordinates_example; // {String} The latitude and longitude of the find place
var opts = {
'searchAreaRestriction': searchAreaRestriction_example, // {String} A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter.
'centerMap': centerMap_example, // {String} Longitude and latitude of the center of the map in degrees.
'orderCoordinates': orderCoordinates_example, // {String} The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude.
'results': 8.14, // {BigDecimal} Number of objects returned. The default is 10. The maximum allowable value is 500.
'language': language_example, // {String} Preferred response language.Example - en_RU.
'toponymType': toponymType_example, // {String} Kind of toponym.
'searchAreaSize': searchAreaSize_example // {String} The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552;
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAddressByCoordinatesPost(apiecoKey, coordinates, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class getAddressByCoordinatesPostExample
{
public void main()
{
// Configure API key authorization: apieco-key
Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");
var apiInstance = new GetAddressByCoordinatesApi();
var apiecoKey = apiecoKey_example; // String |
var coordinates = coordinates_example; // String | The latitude and longitude of the find place
var searchAreaRestriction = searchAreaRestriction_example; // String | A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter. (optional)
var centerMap = centerMap_example; // String | Longitude and latitude of the center of the map in degrees. (optional)
var orderCoordinates = orderCoordinates_example; // String | The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude. (optional)
var results = 8.14; // BigDecimal | Number of objects returned. The default is 10. The maximum allowable value is 500. (optional)
var language = language_example; // String | Preferred response language.Example - en_RU. (optional)
var toponymType = toponymType_example; // String | Kind of toponym. (optional)
var searchAreaSize = searchAreaSize_example; // String | The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552; (optional)
try
{
// Convert a location`s coordinates on the map to an address string.
geo result = apiInstance.getAddressByCoordinatesPost(apiecoKey, coordinates, searchAreaRestriction, centerMap, orderCoordinates, results, language, toponymType, searchAreaSize);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling GetAddressByCoordinatesApi.getAddressByCoordinatesPost: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');
$api_instance = new Swagger\Client\Api\GetAddressByCoordinatesApi();
$apiecoKey = apiecoKey_example; // String |
$coordinates = coordinates_example; // String | The latitude and longitude of the find place
$searchAreaRestriction = searchAreaRestriction_example; // String | A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter.
$centerMap = centerMap_example; // String | Longitude and latitude of the center of the map in degrees.
$orderCoordinates = orderCoordinates_example; // String | The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude.
$results = 8.14; // BigDecimal | Number of objects returned. The default is 10. The maximum allowable value is 500.
$language = language_example; // String | Preferred response language.Example - en_RU.
$toponymType = toponymType_example; // String | Kind of toponym.
$searchAreaSize = searchAreaSize_example; // String | The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552;
try {
$result = $api_instance->getAddressByCoordinatesPost($apiecoKey, $coordinates, $searchAreaRestriction, $centerMap, $orderCoordinates, $results, $language, $toponymType, $searchAreaSize);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling GetAddressByCoordinatesApi->getAddressByCoordinatesPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::GetAddressByCoordinatesApi;
# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";
my $api_instance = WWW::SwaggerClient::GetAddressByCoordinatesApi->new();
my $apiecoKey = apiecoKey_example; # String |
my $coordinates = coordinates_example; # String | The latitude and longitude of the find place
my $searchAreaRestriction = searchAreaRestriction_example; # String | A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter.
my $centerMap = centerMap_example; # String | Longitude and latitude of the center of the map in degrees.
my $orderCoordinates = orderCoordinates_example; # String | The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude.
my $results = 8.14; # BigDecimal | Number of objects returned. The default is 10. The maximum allowable value is 500.
my $language = language_example; # String | Preferred response language.Example - en_RU.
my $toponymType = toponymType_example; # String | Kind of toponym.
my $searchAreaSize = searchAreaSize_example; # String | The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552;
eval {
my $result = $api_instance->getAddressByCoordinatesPost(apiecoKey => $apiecoKey, coordinates => $coordinates, searchAreaRestriction => $searchAreaRestriction, centerMap => $centerMap, orderCoordinates => $orderCoordinates, results => $results, language => $language, toponymType => $toponymType, searchAreaSize => $searchAreaSize);
print Dumper($result);
};
if ($@) {
warn "Exception when calling GetAddressByCoordinatesApi->getAddressByCoordinatesPost: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.GetAddressByCoordinatesApi()
apiecoKey = apiecoKey_example # String |
coordinates = coordinates_example # String | The latitude and longitude of the find place
searchAreaRestriction = searchAreaRestriction_example # String | A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter. (optional)
centerMap = centerMap_example # String | Longitude and latitude of the center of the map in degrees. (optional)
orderCoordinates = orderCoordinates_example # String | The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude. (optional)
results = 8.14 # BigDecimal | Number of objects returned. The default is 10. The maximum allowable value is 500. (optional)
language = language_example # String | Preferred response language.Example - en_RU. (optional)
toponymType = toponymType_example # String | Kind of toponym. (optional)
searchAreaSize = searchAreaSize_example # String | The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552; (optional)
try:
# Convert a location`s coordinates on the map to an address string.
api_response = api_instance.get_address_by_coordinates_post(apiecoKey, coordinates, searchAreaRestriction=searchAreaRestriction, centerMap=centerMap, orderCoordinates=orderCoordinates, results=results, language=language, toponymType=toponymType, searchAreaSize=searchAreaSize)
pprint(api_response)
except ApiException as e:
print("Exception when calling GetAddressByCoordinatesApi->getAddressByCoordinatesPost: %s\n" % e)
Parameters
Header parameters
Name | Description |
---|---|
apieco-key* |
String
Required
|
Query parameters
Name | Description |
---|---|
coordinates* |
String
The latitude and longitude of the find place
Required
|
searchAreaRestriction |
String
A sign of a hard limitation of the search area. Use with alternativeSearch or searchAreaSize + mapCenter.
|
centerMap |
String
Longitude and latitude of the center of the map in degrees.
|
orderCoordinates |
String
The order of coordinates (only for reverse geocoding). Possible values are:Longlat - longitude, latitude (default);Latlong - latitude, longitude.
|
results |
BigDecimal
Number of objects returned. The default is 10. The maximum allowable value is 500.
|
language |
String
Preferred response language.Example - en_RU.
|
toponymType |
String
Kind of toponym.
|
searchAreaSize |
String
The length of the map display area by longitude and latitude (in degrees).Example - 0.552069,0.400552;
|