Skip to content

About

A SaaS search engine for Telegram files. Allows users to connect their own MongoDB clausters and deploy personalized, glassmorphism-styled file search interfaces. Main Page - https://find.dhyey.space and user based page πŸ‘‡πŸ»

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

Β 

History

23 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ“˜ find.dhyey.space β€” Search API Documentation

This document explains how to use the public Search API of find.dhyey.space, including all supported query parameters, usage examples, and how the Telegram file delivery API works.


✨ Features

  • Instant Search: Results appear as you type with efficient debounce.
  • Smart Suggestions: Auto-complete and fuzzy matching for typos.
  • Recent History: Quickly access your last 5 searches.
  • Dynamic Stats: Search placeholder shows live total file count (e.g., "Search 500,000+ files").
  • Keyboard Shortcuts: Press / to focus the search bar instantly.
  • Copy Link: Quickly copy the Telegram deep link to your clipboard.
  • Zero-State Tips: Helpful suggestions when no results are found.
  • Glassmorphism Design: Sleek, semi-transparent panels with blur effects.
  • Dynamic Themes: Choose from Violet, Emerald, Amber, Rose, or Sky themes.

πŸ” Base Search Endpoint

https://find.dhyey.space/api/search

This endpoint returns indexed files stored in MongoDB based on search filters.


πŸ“₯ How to Use the API

You pass search parameters like this:

https://find.dhyey.space/api/search?q=QUERY

πŸ”Ή If the search term contains spaces

Use URL encoding:

Search Term Encoded URL
Deforestation Deforestation
Cartesian Curve Cartestian%20curve OR Cartestian+curve

Example:

https://find.dhyey.space/api/search?q=cisc%20risc

βš™οΈ Query Parameters Supported

Below is the complete list of parameters supported by your Search API.


1️⃣ q β€” Search Query (string)

Case-insensitive search on the configured SEARCH_FIELD_NAME.

Examples:

https://find.dhyey.space/api/search?q=engineering

With space:

https://find.dhyey.space/api/search?q=cisc%20risc

πŸ“¦ API Response Format (JSON)

Example response:

{
  "page": 1,
  "per_page": 50,
  "items": [
    {
      "id": "67a3f9d39184bb0d1c2f1234",
      "file_name": "Example File.pdf",
      "file_size": 102400,
      "caption": "Some caption",
      "year": 2023,
      "file_type": "pdf"
    }
  ]
}

πŸ€– File Delivery API

You can deliver any indexed file through your Telegram bot using:

https://find.dhyey.space/api/send_link/<file_id>

Example

https://find.dhyey.space/api/send_link/67a3f9d39184bb0d1c2f1234

Response

{
  "link": "https://t.me/dhyeyautofilterbot?start=file_1123135015_67a3f9d39184bb0d1c2f1234"
}

Opening that link in Telegram sends the file to the user.


οΏ½ Internal Process Flow

Below is the process of how files flow through your system:

graph TD
    User[User Uploads File/Media] --> Storage[File stored in Storage]
    Storage --> Index[Metadata Indexed in MongoDB]
    Index --> Website[Website find.dhyey.space Lists Files]
    Website --> Search[User Searches -> /api/search Executes]
    Search --> Results[Results Displayed]
    Results --> Select[User Selects File]
    Select --> API[API /api/send_link/file_id]
    API --> Bot[Telegram Bot Sends File to User]
Loading

πŸ› οΈ Installation & Setup (For Developers)

  1. Clone the Repository:

    git clone https://github.com/dhyeyppatel/File-Finder-Web.git
    cd File-Finder-Web
  2. Install Dependencies:

    pip install -r requirements.txt
  3. Configure Environment: Create a .env file:

    MONGO_URI=mongodb+srv://...
    DB_NAME=your_db
    COLLECTION_NAME=your_collection
    SEARCH_FIELD_NAME=file_name
  4. Run the App:

    python app.py

About

A SaaS search engine for Telegram files. Allows users to connect their own MongoDB clausters and deploy personalized, glassmorphism-styled file search interfaces. Main Page - https://find.dhyey.space and user based page πŸ‘‡πŸ»

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages