Skip to main content
This function allows you to retrieve a single conversion by its unique identifier, see an example below:
You should authenticate/initialize Ip2Geo before using this method.
import { GetConversion } from '@ip2geo/sdk'

const conversionId = 'your-conversion-uuid'

const { data, success, message } = await GetConversion({
    conversionId: conversionId
})

result = Ip2Geo.get_conversion(conversion_id: 'your-conversion-uuid')

# {
#     'success' => true,
#     'code' => 200,
#     'message' => 'Success',
#     'data' => { ... },
#     '_req' => { 'reqId' => '...', 'resTime' => 123 }
# }

import ip2geo

result = ip2geo.get_conversion(conversion_id='your-conversion-uuid')

# {
#     'success': True,
#     'code': 200,
#     'message': 'Success',
#     'data': { ... },
#     '_req': { 'reqId': '...', 'resTime': 123 }
# }

<?php

use Ip2Geo\Ip2Geo;

$result = Ip2Geo::getConversion(conversionId: 'your-conversion-uuid');

// [
//     'success' => true,
//     'code' => 200,
//     'message' => 'Success',
//     'data' => [ ... ],
//     '_req' => ['reqId' => '...', 'resTime' => 123],
// ]

​
With Select Fields

You can select specific fields from the conversion data object using the select parameter: 
import { GetConversion, SELECT } from '@ip2geo/sdk'

const { data, success, message } = await GetConversion({
    conversionId: 'your-conversion-uuid',
    select: [
        SELECT.COUNTRY_NAME,
        SELECT.COUNTRY_CODE,
        SELECT.ASN_NAME
    ]
})

// Response data structure:
// {
//     data: {
//         continent: {
//             country: {
//                 name: 'United States',
//                 code: 'US'
//             }
//         },
//         asn: {
//             name: 'Cloudflare'
//         }
//     }
// }

result = Ip2Geo.get_conversion(
    conversion_id: 'your-conversion-uuid',
    select: [
        Ip2Geo.select[:COUNTRY_NAME],
        Ip2Geo.select[:COUNTRY_CODE],
        Ip2Geo.select[:ASN_NAME]
    ]
)

# Response data structure:
# {
#     'data' => {
#         'continent' => {
#             'country' => {
#                 'name' => 'United States',
#                 'code' => 'US'
#             }
#         },
#         'asn' => {
#             'name' => 'Cloudflare'
#         }
#     }
# }

import ip2geo

result = ip2geo.get_conversion(
    conversion_id='your-conversion-uuid',
    select=[
        ip2geo.SELECT['COUNTRY_NAME'],
        ip2geo.SELECT['COUNTRY_CODE'],
        ip2geo.SELECT['ASN_NAME'],
    ]
)

# Response data structure:
# {
#     'data': {
#         'continent': {
#             'country': {
#                 'name': 'United States',
#                 'code': 'US'
#             }
#         },
#         'asn': {
#             'name': 'Cloudflare'
#         }
#     }
# }

<?php

use Ip2Geo\Ip2Geo;

$result = Ip2Geo::getConversion(
    conversionId: 'your-conversion-uuid',
    select: [
        Ip2Geo::SELECT['COUNTRY_NAME'],
        Ip2Geo::SELECT['COUNTRY_CODE'],
        Ip2Geo::SELECT['ASN_NAME'],
    ],
);

// Response data structure:
// [
//     'data' => [
//         'continent' => [
//             'country' => [
//                 'name' => 'United States',
//                 'code' => 'US',
//             ],
//         ],
//         'asn' => [
//             'name' => 'Cloudflare',
//         ],
//     ],
// ]

​
Parameters

​
conversionId
string
required
The unique identifier (UUID) of the conversion to retrieve.
​
select
Array<SelectField>
Select specific data fields to return. If not specified, all data fields are returned. See SELECT Constants for all available fields.

​
Response

​
success
boolean
Whether the request was successful.
​
message
string
Response message describing the result.
​
code
number
HTTP status code.
​
data
Conversion | Partial<Conversion> | null
The conversion data. If select was specified, only the selected fields are returned. Returns null if the conversion was not found.
​
_req
object
Request metadata containing:
  • reqId: Unique request identifier.
  • resTime: Response time in milliseconds.
For all available SELECT constants and their values, see the SELECT Constants reference.