curl --request GET \
--url https://api.influship.com/v1/search/{id} \
--header 'X-API-Key: <api-key>'import Influship from 'influship';
const client = new Influship({
apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const searchRetrieveResponse of client.search.retrieve(
'123e4567-e89b-12d3-a456-426614174000',
)) {
console.log(searchRetrieveResponse.creator);
}import requests
url = "https://api.influship.com/v1/search/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"creator": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Jane Fitness",
"bio": "Fitness coach and home-workout creator",
"avatar_url": null
},
"relevant_profile": null,
"primary_profile": null,
"location_unverified": null,
"match": {
"score": 0.85,
"confidence": 0.85,
"low_confidence": false,
"ranking_source": "reranked",
"reasons": [
"Publishes practical home-workout tutorials."
],
"evidence": [
{
"text": "Publishes practical home-workout tutorials.",
"provenance": "post_evidence",
"fact_id": null,
"source_post_id": "23256c2e-51fa-4389-a4a1-945e461e951b",
"evidence_quote": "Here are three bodyweight exercises for a quick home workout."
}
]
}
}
],
"quality": {
"mode": "reranked",
"reason": null
},
"search_id": "987fcdeb-51a2-43d7-8b90-123456789abc",
"total": 1,
"has_more": false,
"next_cursor": null
}{
"error": {
"code": "validation_error",
"message": "Invalid value for parameter 'limit': must be between 1 and 100",
"param": "limit",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "unauthorized",
"message": "API key missing or invalid",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "payment_required",
"message": "Payment authentication is required.",
"status_code": 402,
"reason_code": "PAYMENT_ACTION_REQUIRED",
"next_step": "complete_authentication",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "forbidden",
"message": "Your plan does not include access to this endpoint",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "not_found",
"message": "Creator with ID '123e4567-e89b-12d3-a456-426614174000' not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded (per minute)",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "service_unavailable",
"message": "Live Instagram data is temporarily unavailable. Please retry shortly.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"details": {
"retry_after_seconds": 60,
"upstream_error": "upstream_rate_limited"
}
}
}Get Search Results Page
Paginate through results from a previous search. Use the search_id returned by POST /v1/search to fetch additional pages.
Search sessions expire after 1 hour. After expiry, a new search must be run.
Pricing: 0 credits (included with initial search)
curl --request GET \
--url https://api.influship.com/v1/search/{id} \
--header 'X-API-Key: <api-key>'import Influship from 'influship';
const client = new Influship({
apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const searchRetrieveResponse of client.search.retrieve(
'123e4567-e89b-12d3-a456-426614174000',
)) {
console.log(searchRetrieveResponse.creator);
}import requests
url = "https://api.influship.com/v1/search/{id}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"creator": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"name": "Jane Fitness",
"bio": "Fitness coach and home-workout creator",
"avatar_url": null
},
"relevant_profile": null,
"primary_profile": null,
"location_unverified": null,
"match": {
"score": 0.85,
"confidence": 0.85,
"low_confidence": false,
"ranking_source": "reranked",
"reasons": [
"Publishes practical home-workout tutorials."
],
"evidence": [
{
"text": "Publishes practical home-workout tutorials.",
"provenance": "post_evidence",
"fact_id": null,
"source_post_id": "23256c2e-51fa-4389-a4a1-945e461e951b",
"evidence_quote": "Here are three bodyweight exercises for a quick home workout."
}
]
}
}
],
"quality": {
"mode": "reranked",
"reason": null
},
"search_id": "987fcdeb-51a2-43d7-8b90-123456789abc",
"total": 1,
"has_more": false,
"next_cursor": null
}{
"error": {
"code": "validation_error",
"message": "Invalid value for parameter 'limit': must be between 1 and 100",
"param": "limit",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "unauthorized",
"message": "API key missing or invalid",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "payment_required",
"message": "Payment authentication is required.",
"status_code": 402,
"reason_code": "PAYMENT_ACTION_REQUIRED",
"next_step": "complete_authentication",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "forbidden",
"message": "Your plan does not include access to this endpoint",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "not_found",
"message": "Creator with ID '123e4567-e89b-12d3-a456-426614174000' not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "Rate limit exceeded (per minute)",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "internal_error",
"message": "An unexpected error occurred. Please try again later.",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "service_unavailable",
"message": "Live Instagram data is temporarily unavailable. Please retry shortly.",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"details": {
"retry_after_seconds": 60,
"upstream_error": "upstream_rate_limited"
}
}
}Authorizations
Path Parameters
Search ID returned from POST /v1/search
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"123e4567-e89b-12d3-a456-426614174000"
Query Parameters
Maximum results to return
1 <= x <= 10025
Pagination cursor for next page
Response
Successful response
Show child attributes
Show child attributes
Search ID. Use with GET /v1/search/{id} for free pagination.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"123e4567-e89b-12d3-a456-426614174000"
Total number of results across all pages
-9007199254740991 <= x <= 90071992547409911
Whether more results are available
false
Cursor for the next page
null
How results were ranked: all with AI relevance scoring, a mix of AI and discovery ranking, or discovery ranking throughout. When omitted, treat the response as reranked. Use each match.ranking_source to interpret its score.
- Option 1
- Option 2
- Option 3
Show child attributes
Show child attributes