# Query IP Information - QueryIpLocation

## Overview

Query IP Information






## Definition

### Public Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Action**     | string  | Corresponding API command name, the current API is `QueryIpLocation`.                      | **Yes** |
| **PublicKey**  | string  | The user's public key can be obtained from [Console](https://console.scloudsg.com/uaccount/api_manage)                                             | **Yes** |
| **Signature**  | string  | User signature generated based on public key and API command, see [Signature Algorithm](/docs/api/summary/signature.md)  | **Yes** |

### Request Parameters

| Parameter Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Ip.N** | string | IP List |**Yes**|

### Response Field

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **RetCode** | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. |**Yes**|
| **Action** | string | Operation command name. |**Yes**|
| **Message** | string | Returns an error message, providing detailed description when `RetCode` is non-zero. |No|
| **Data** | array[[*IpLocationInfo*](#iplocationinfo)] | IP Information List |**Yes**|

#### Data Model


#### IpLocationInfo

| Field Name | Type | Description Information | Required |
|:---|:---|:---|:---|
| **Ip** | string | IP of client request |No|
| **Area** | string | Region |No|
| **Isp** | string | Carrier |No|
| **City** | string | City |No|
| **Exist** | boolean | Does the IP exist? |No|

## Example

### Request Example
    
```
https://api.scloudsg.com/?Action=QueryIpLocation
&Ip.n=JjOUYgbl
```

### Response Example
    
```json
{
  "Action": "QueryIpLocationResponse",
  "Data": [
    {
      "Area": "mVVetvPX",
      "City": "qGLzrhND",
      "Exist": false,
      "Ip": "JNvcgwzh",
      "Isp": "NbVGrLKP"
    }
  ],
  "RetCode": 0
}
```