# openapi.api.SearchApi ## Load the API package ```dart import 'package:openapi/api.dart'; ``` All URIs are relative to */api* Method | HTTP request | Description ------------- | ------------- | ------------- [**getExploreData**](SearchApi.md#getexploredata) | **GET** /search/explore | [**search**](SearchApi.md#search) | **GET** /search | [**searchPerson**](SearchApi.md#searchperson) | **GET** /search/person | # **getExploreData** > List getExploreData() ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = SearchApi(); try { final result = api_instance.getExploreData(); print(result); } catch (e) { print('Exception when calling SearchApi->getExploreData: $e\n'); } ``` ### Parameters This endpoint does not need any parameter. ### Return type [**List**](SearchExploreResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **search** > SearchResponseDto search(q, query, clip, type, recent, motion) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = SearchApi(); final q = q_example; // String | final query = query_example; // String | final clip = true; // bool | final type = type_example; // String | final recent = true; // bool | final motion = true; // bool | try { final result = api_instance.search(q, query, clip, type, recent, motion); print(result); } catch (e) { print('Exception when calling SearchApi->search: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **q** | **String**| | [optional] **query** | **String**| | [optional] **clip** | **bool**| | [optional] **type** | **String**| | [optional] **recent** | **bool**| | [optional] **motion** | **bool**| | [optional] ### Return type [**SearchResponseDto**](SearchResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) # **searchPerson** > List searchPerson(name, withHidden) ### Example ```dart import 'package:openapi/api.dart'; // TODO Configure API key authorization: cookie //defaultApiClient.getAuthentication('cookie').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('cookie').apiKeyPrefix = 'Bearer'; // TODO Configure API key authorization: api_key //defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY'; // uncomment below to setup prefix (e.g. Bearer) for API key, if needed //defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer'; // TODO Configure HTTP Bearer authorization: bearer // Case 1. Use String Token //defaultApiClient.getAuthentication('bearer').setAccessToken('YOUR_ACCESS_TOKEN'); // Case 2. Use Function which generate token. // String yourTokenGeneratorFunction() { ... } //defaultApiClient.getAuthentication('bearer').setAccessToken(yourTokenGeneratorFunction); final api_instance = SearchApi(); final name = name_example; // String | final withHidden = true; // bool | try { final result = api_instance.searchPerson(name, withHidden); print(result); } catch (e) { print('Exception when calling SearchApi->searchPerson: $e\n'); } ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **name** | **String**| | **withHidden** | **bool**| | [optional] ### Return type [**List**](PersonResponseDto.md) ### Authorization [cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)