PHP SDK location service

Use $avraapi->location() to resolve one permitted IP address. The Location service has one released operation and returns an ApiResponse.

Use $avraapi->location()->withPrivacyMode()->lookupIp('IP_ADDRESS') for the shared one-request privacy control. It sends X-Privacy-Mode: 1 only for that next request, then clears automatically. Privacy Mode keeps normal routing, billing, and usage tracking while suppressing request and response payload storage. The existing privacyMode: true argument remains supported.

Look up an IP address

lookupIp(string $ip, bool $privacyMode = false): ApiResponse accepts IPv4 or IPv6 text. The optional privacyMode: true argument remains available; for a consistent fluent style, use withPrivacyMode() immediately before the call. SDK function

Copy the SDK call

$response = $avraapi->location()
    ->withPrivacyMode()
    ->lookupIp(ip: 'IP_ADDRESS');

Argument	Use
`ip`	Permitted IPv4 or IPv6 address.
`privacyMode`	Optional legacy convenience argument; `true` sends `X-Privacy-Mode: 1`.

Resolve an IP address with the shared privacy control

<?php

// AvraAPI SDK call.
$response = $avraapi->location()
    ->withPrivacyMode()
    ->lookupIp(ip: '8.8.8.8');

// Your application code.
$location = [
    'country' => $response->data['country'],
    'city' => $response->data['city'],
    'timezone' => $response->data['timezone'],
    'coordinates' => [
        'latitude' => $response->data['latitude'],
        'longitude' => $response->data['longitude'],
    ],
];
$requestId = $response->requestId;

Response

{
  "success": true,
  "request_id": "67257c6b-c48f-42f6-9d96-0224c504c30b",
  "data": {
    "country": "Sri Lanka",
    "country_code": "LK",
    "city": "Colombo",
    "isp": "Starlink IPv4 Customer Space",
    "latitude": 6.9394,
    "longitude": 79.8476,
    "timezone": "Asia/Colombo"
  },
  "meta": {
    "provider_override": null
  }
}

Every result field can be null when the selected provider has no matching data. Privacy mode preserves normal routing, billing, and usage tracking while suppressing request and response payload storage. It does not anonymise the request. See the REST API guide for the shared privacy guarantee.

Select a configured provider for one request

Every PHP provider service inherits withProvider(string $providerCode): static. It sets an X-Provider-Override header for the next request only, then the SDK clears the override. Use it only with a provider that is configured for the selected project environment.

Optional provider selection

<?php

// AvraAPI SDK call. The override affects this lookup only.
$response = $avraapi->location()
    ->withProvider('maxmind')
    ->lookupIp('2001:4860:4860::8888');

// Your application code.
$providerHint = $response->meta['provider_override'];

meta.provider_override reports the requested hint. It does not guarantee that every returned field originated from that provider.

Use the result safely

Keep Location calls in your backend and process only IP addresses you are permitted to use. Do not treat country, city, network, or coordinate fields as identity proof. The Location REST API Reference contains the full request, field, and error contract. For SDK failures, use the typed exception pattern in PHP Overview and setup and retain the exception request ID for support.

Introduction

PHP SDK (v1.5.2)

Laravel SDK (v1.2.0)

Node.js SDK (v1.2.0)

PHP SDK location service

Look up an IP address

Response

Select a configured provider for one request

Use the result safely

​Look up an IP address

​Response

​Select a configured provider for one request

​Use the result safely

Look up an IP address

Response

Select a configured provider for one request

Use the result safely