Get Conversion

This function allows you to retrieve a single conversion by its unique identifier. Conversions are kept for twelve months after the month they were made, then deleted, so older ones are no longer returned. 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 (uniqueId always comes along):
// {
//     uniqueId: '01a12452-07a0-7a3b-8c41-d2e5f6a7b8c9',
//     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 (uniqueId always comes along):
# {
#     'uniqueId' => '01a12452-07a0-7a3b-8c41-d2e5f6a7b8c9',
#     '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 (uniqueId always comes along):
# {
#     'uniqueId': '01a12452-07a0-7a3b-8c41-d2e5f6a7b8c9',
#     '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 (uniqueId always comes along):
// [
//     'uniqueId' => '01a12452-07a0-7a3b-8c41-d2e5f6a7b8c9',
//     'data' => [
//         'continent' => [
//             'country' => [
//                 'name' => 'United States',
//                 'code' => 'us',
//             ],
//         ],
//         'asn' => [
//             'name' => 'Cloudflare',
//         ],
//     ],
// ]

Parameters

conversionIdstringrequired

The unique identifier (UUID) of the conversion to retrieve.

selectArray<SelectField>

Select the fields to return. Geolocation fields, the SELECT Constants, are read under data, and the stored fields (id, uniqueId, status, startedAt, completedAt, createdAt) can be named as they are. uniqueId always comes along, so every row can be matched to its conversion. If not specified, every field is returned.

Response

successboolean

Whether the request was successful.

messagestring

Response message describing the result.

codenumber

HTTP status code.

dataConversion | Partial<Conversion> | null

The conversion data. If select was specified, only the selected fields are returned. Returns null if the conversion was not found.

_reqobject

Request metadata containing:

reqId: Unique request identifier.
resTime: Response time in milliseconds.

Parameters

conversion_idStringrequired

The unique identifier (UUID) of the conversion to retrieve.

selectArray<String>

Response

successBoolean

Whether the request was successful.

messageString

Response message describing the result.

codeInteger

HTTP status code.

dataHash | nil

The conversion data. If select was specified, only the selected data fields are returned. Returns nil if the conversion was not found.

_reqHash

Request metadata containing:

‘reqId’: Unique request identifier.
‘resTime’: Response time in milliseconds.

Parameters

conversion_idstrrequired

The unique identifier (UUID) of the conversion to retrieve.

selectlist[str]

Response

successbool

Whether the request was successful.

messagestr

Response message describing the result.

codeint

HTTP status code.

datadict | None

The conversion data. If select was specified, only the selected data fields are returned. Returns None if the conversion was not found.

_reqdict

Request metadata containing:

‘reqId’: Unique request identifier.
‘resTime’: Response time in milliseconds.

Parameters

conversionIdstringrequired

The unique identifier (UUID) of the conversion to retrieve.

selectarray

Response

successbool

Whether the request was successful.

messagestring

Response message describing the result.

codeint

HTTP status code.

dataarray | null

The conversion data. If select was specified, only the selected data fields are returned. Returns null if the conversion was not found.

_reqarray

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.

Get Conversion

With Select Fields

Parameters

Response

Parameters

Response

Parameters

Response

Parameters

Response

Convert IPs into accurate location data in milliseconds.