Ip2location

Learn how to use Ip2location with Composio

Overview

SLUG: IP2LOCATION

Description

IP2Location.io provides fast and accurate IP geolocation data, including country, city, ISP, latitude, longitude, and more, supporting both IPv4 and IPv6 lookups.

Authentication Details

generic_key
stringRequired

Connecting to Ip2location

Create an auth config

Use the dashboard to create an auth config for the Ip2location toolkit. This allows you to connect multiple Ip2location accounts to Composio for agents to use.

1

Select App

Navigate to Ip2location.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Ip2location Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4ip2location_auth_config_id = "ac_YOUR_IP2LOCATION_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Ip2location for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, ip2location_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Ip2location toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["IP2LOCATION"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Bulk IP Geolocation

Description

Tool to retrieve geolocation information for multiple IP addresses in bulk. Use when you need batch processing of up to 1000 IPs per request.

Action Parameters

fields
array
format
stringDefaults to json
ips
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check IP2Location API Credits

Description

Tool to check remaining IP2Location API credits. Use after setting up authentication to monitor usage.

Action Parameters

key
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: IP2WHOIS Hosted Domains Lookup

Description

Tool to retrieve hosted domains for a given IP address. Use when you need to list domains hosted on an IP.

Action Parameters

format
stringDefaults to json
ip
stringRequired
key
stringRequired
page
integerDefaults to 1

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: IP2Location Get IP Geolocation

Description

Tool to retrieve geolocation data for an IP address. Use when detailed IP location info is needed.

Action Parameters

addon
array
format
stringDefaults to json
ip
stringRequired
lang
string
package
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: IP2Proxy: Get Proxy Detection

Description

Tool to detect if an IP is a proxy, VPN, or TOR exit node. Use when verifying anonymizing services.

Action Parameters

check
integer
ip
stringRequired
package
stringDefaults to PX1

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: IP2Location Distance Calculator

Description

Tool to calculate distance between two IPs. Use when geographic separation between two IP addresses is needed.

Action Parameters

ip1
stringRequired
ip2
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: IP2WHOIS Domain WHOIS Lookup

Description

Tool to retrieve WHOIS information for a domain. Use when you need domain registration details.

Action Parameters

domain
stringRequired
format
stringDefaults to json

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: IP2Location List IPs

Description

Tool to list a curated set of test IPv4 and IPv6 addresses. Use when sample IPs are needed for IP2Location or IP2Proxy lookups during development or testing.

Action Parameters

type
stringDefaults to all

Action Response

data
objectRequired
error
string
successful
booleanRequired