Documentation

    Amazon Web Services

    Microsoft Azure

    RapidAPI

    APILayer

Last Update: 2024-09-11

IP Address Geolocation API


Table of Content


Subscribe on AWS Marketplace
Code sample
API endpoint: /get-location
API endpoint: /usage
Troubleshooting

Subscribe on AWS Marketplace


Navigate to our product listing on the AWS Marketplace. Select the "View purchase options" button to proceed.

On the following page, click the "Subscribe" button to initiate the subscription process.

After subscribing, you will need to set up your account on our platform. Do this by clicking the "Set up your account" link provided.

You will be directed to the registration page. Here, fill in your account details in the provided fields. Once you have entered all necessary information, click the 'Subscribe' button to proceed.

Upon successful registration, your unique API key will be displayed. It is crucial to store this key in a secure location for future use.

Code Samples


The code samples below calls the '/get-location' endpoint in order to retrieve the country, state, city, and latitude/longitude for the specified IP address. Replace <YourApiKey> with the actual API Key you received during the sign-up process:

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "https://ip-aws.silverlining.cloud/get-location");
request.Headers.Add("x-api-key", "<YourApiKey>");
var content = new StringContent("{\n    \"ip_address\": \"143.50.237.65\"\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
IP Geolocation Playground

This API Playground for our IP Geolocation API allows you to test the service in real-time. Simply enter the IP address you want to locate, and you’ll receive an immediate response directly from the API. Whether you’re integrating IP geolocation into your application or just experimenting with the service, the playground provides a user-friendly interface to see real-time results instantly.

    "To see the result, please send a request to the API."
    API endpoint: /get-location


    URL endpoint: https://ip-aws.silverlining.cloud/get-location
    
    
    Method: POST
    
    
    "header": {
      "x-api-key": STRING,
      "Content-Type": "application/json"
    }
    
    
    "body": {
      "ip_address": STRING
    }



    Required

    "ip_address": The IP address for which geolocation information is required.


    Response:
    
    "body": {
      "ip_address": STRING,
      "country": STRING,
      "state": STRING,
      "city": STRING,
      "latitude": NUMBER,
      "longitude": NUMBER
    }   


    "ip_address": The provided IP address.
    "country": The country to which the IP address is assigned.
    "state": The state or province to which the IP address is assigned.
    "city": The city to which the IP address is assigned.
    "latitude" / "longitude": The latitude and longitude geolocation of the assigned city.

    API endpoint: Usage

    URL endpoint: https://ip-aws.silverlining.cloud/usage
    
    
    Method: POST
    
    
    "header": {
      "x-api-key": STRING,
      "Content-Type": "application/json"
    }

    Required 
    You must include the API key in the x-api-key header. The body parameters can be left empty.

    Response:
    
    
    "body": {
      "reportUrl": STRING,
      "downloadLink": STRING,
      "description": STRING
    }

    "reportUrl": A URL linking to a web-based report that displays all requests made to the API. Note that this report is only accessible if the total number of requests is below 100,000.

    "downloadLink": A URL to download a .CSV file containing all requests made to our API using the specified API key.

    "description": You can access usage statistics either by visiting the website using the 'reportUrl' or by downloading the usage data as a .csv file using the 'downloadLink'. Please note that, depending on the number of requests you have previously sent to our API, these links may become available up to 10 minutes after the request is made.

    Troubleshooting

    "message": "Invalid Input: The request contains incorrectly formatted parameters"

    This error message means that the body parameters you have passed are malformed. Please follow the instructions given in the endpoint descriptions. Common issues include forgetting to add a comma (',') after every parameter line or missing a parenthesis somewhere.

    "message": "Endpoint request timed out"

    You receive this error message when the code execution exceeds the maximum timeout (usually 29 seconds).

    How can I cancel my subscription?

    To cancel your subscription, follow these steps:

    1. Go to the AWS Marketplace Console at https://aws.amazon.com/marketplace/library. Ensure that you are logged into the account that is subscribed to the product you want to cancel.
    2. Find the product you want to cancel and click on 'Manage.'
    3. Click on 'Actions' and then select 'Cancel subscription.'

    For more detailed instructions, visit the AWS Marketplace Buyer Guide at https://docs.aws.amazon.com/marketplace/latest/buyerguide/cancel-subscription.html.