# Search

1. **Search Suggestion and Prices**

* **GET** `/api/v1/white-label-logic/search`

This endpoint allows users to search for available domain names and their corresponding pricing information based on the provided search string.

**Query Parameters**

| **Parameter** | **Type** | **Description**                                                                      |
| ------------- | -------- | ------------------------------------------------------------------------------------ |
| searchString  | String   | \[Required] The desired domain name for which the user wants suggestions and prices. |

**Response**

```
api/v1/white-label-logic/search?searchString=test.influencer
```

```json
{
    "result": true,
    "data": {
        "result": [
            {
                "type": "EXACT_MATCH",
                "elements": [
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "test.influencer",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "398.90"
                        },
                        "url": "https://freename.io/results?search=%22test.influencer%22"
                    }
                ]
            },
            {
                "type": "SUGGESTED_TLD",
                "elements": [
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": ".question",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "299.00"
                        },
                        "url": "https://freename.io/results?search=%22.question%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": ".effect",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "399.00"
                        },
                        "url": "https://freename.io/results?search=%22.effect%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": ".essay",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "499.00"
                        },
                        "url": "https://freename.io/results?search=%22.essay%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": ".holistic",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "299.00"
                        },
                        "url": "https://freename.io/results?search=%22.holistic%22"
                    }
                ]
            },
            {
                "type": "SEARCH_STRING_AS_SECOND_LEVEL_DOMAIN",
                "elements": [
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "test.investigation",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "278.90"
                        },
                        "url": "https://freename.io/results?search=%22test.investigation%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "test.exam",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "199.90"
                        },
                        "url": "https://freename.io/results?search=%22test.exam%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "test.investigate",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "199.90"
                        },
                        "url": "https://freename.io/results?search=%22test.investigate%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "test.sinewy",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "598.90"
                        },
                        "url": "https://freename.io/results?search=%22test.sinewy%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "test.admirable",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "398.90"
                        },
                        "url": "https://freename.io/results?search=%22test.admirable%22"
                    }
                ]
            },
            {
                "type": "SECOND_LEVEL_DOMAIN_WITH_SEARCH_STRING_AS_TLD",
                "elements": [
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "reputable.influencer",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "209.00"
                        },
                        "url": "https://freename.io/results?search=%22reputable.influencer%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "ordeal.influencer",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "224.00"
                        },
                        "url": "https://freename.io/results?search=%22ordeal.influencer%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "authoritative.influencer",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "204.00"
                        },
                        "url": "https://freename.io/results?search=%22authoritative.influencer%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "important.influencer",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "498.00"
                        },
                        "url": "https://freename.io/results?search=%22important.influencer%22"
                    },
                    {
                        "availabilityStatus": "AVAILABLE",
                        "name": "investigation.influencer",
                        "price": {
                            "currency": "USD",
                            "valueFormatted": "204.00"
                        },
                        "url": "https://freename.io/results?search=%22investigation.influencer%22"
                    }
                ]
            }
        ],
        "errors": []
    }
}

```

**Response Structure:**

* `result`: Indicates whether the search was successful.
* `data`: Contains the search results.
  * `result`: Contains different types of search results.
    * `type`: Type of search result.
    * `elements`: List of elements corresponding to the search result type.
      * `availabilityStatus`: Availability status of the domain.
      * `name`: Domain name.
      * `asciiName`: ASCII representation of the domain name.
      * `type`: Type of domain.
      * `level`: Domain level.
      * `price`: Pricing information for the domain.
        * `currency`: Currency of the price.
        * `valueStringed`: Price in string format.
        * `valueFormatted`: Price in formatted string format.
        * `amount`: Price in numerical format.
      * `detailedTld`: Detailed information about the top-level domain.
        * `isTldOwned`: Indicates whether the top-level domain is owned.
        * `asciiName`: ASCII representation of the top-level domain.
        * `name`: Name of the top-level domain.
      * `domainPrice`: Pricing information specific to the domain.
        * `currency`: Currency of the price.
        * `valueStringed`: Price in string format.
        * `valueFormatted`: Price in formatted string format.
        * `amount`: Price in numerical format.
      * `url`: URL to view more details about the domain.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://freename-1.gitbook.io/freename-apis/web3-white-label-apis/white-label-controller/search.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.