---
title: "Search for users by username or display name"
method: GET
path: "/api/v1/users/search"
tags: ["Users"]
---

# Search for users by username or display name

`GET /api/v1/users/search`

## Request

- Base URL: `https://api.instadram.me/v1`
- URL: `https://api.instadram.me/v1/api/v1/users/search`
- Auth: HTTP bearer

## Query parameters

- `q` string, required

## Response `200`

User search results

- object
  - `success` boolean
  - `data` object
    - `users` UserProfile[]
      - `id` string: User ID
      - `display_name` string: User display name
      - `email` string: User email
      - `photo_url` string: User photo URL
      - `created_at` string, date-time: Account creation timestamp
      - `updated_at` string, date-time: Last update timestamp
      - `collection_count` integer: Number of collections
      - `bottle_count` integer: Number of bottles
    - `total_count` integer

---

[API](https://skmtc.dev/instadram/apis/instadram-api.md) · [All operations](https://skmtc.dev/instadram/apis/instadram-api/llms.txt) · [OpenAPI document](https://skmtc.dev/instadram/apis/instadram-api/revisions/2971df0f7ef1?raw)