# \DeviceApi
All URIs are relative to *https://api.orangefox.download*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_device**](DeviceApi.md#get_device) | **GET** /devices/get | Get Device
[**get_device_deprecated**](DeviceApi.md#get_device_deprecated) | **GET** /devices/{device_id} | Get Device Short
[**get_devices**](DeviceApi.md#get_devices) | **GET** /devices/ | Get Devices
[**get_oems**](DeviceApi.md#get_oems) | **GET** /oems/ | Get Oems
## get_device
> models::DeviceResponse get_device(device_id, _id, codename)
Get Device
Extended get device method, including the ability to get a device using device codename instead of the ID. /device/get?codename=lavender Due to the reasons mentioned in the /device route, identification devices using their codenames are considered unrecommended.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**device_id** | Option<**String**> | | |
**_id** | Option<**String**> | Filter by Device ID (deprecated) | |
**codename** | Option<**String**> | Not recommended to use when you can | |
### Return type
[**models::DeviceResponse**](DeviceResponse.md)
### Authorization
No authorization required
### 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)
## get_device_deprecated
> models::DeviceResponse get_device_deprecated(device_id)
Get Device Short
Gets device info using device ID.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**device_id** | **String** | | [required] |
### Return type
[**models::DeviceResponse**](DeviceResponse.md)
### Authorization
No authorization required
### 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)
## get_devices
> models::ListResponseShortDeviceResponse get_devices(id, _id, oem_name, codename, model_name, supported, maintainer, freezed, has_releases, skip, limit)
Get Devices
Get a device list. Device ID is the internal OrangeFox device identifier (https://www.mongodb.com/docs/manual/reference/method/ObjectId/). Please only use it for identification instead of codename or model_name if it's possible. You would find two Device ID query parameters here, the _id one is left deprecated due to historical reasons, please use id instead. Please note that using model_name is unrecommended and considered deprecated as it's very inconsistent around some OEMs that play with the names around. As of the current moment, the API won't support unified model names at all! In short, do not use model_name as device's identification. Be careful using codenames, there are a lot of problems and pain about those. Some OEMs keep releasing new phones with the same hardware as the old ones and may or may not update or change the codename for those. Currently, API doesn't support unified devices; they would have only one codename. Our OEMs database would not include subbrands, they instead would be added to the model name. Like oem_name: \"Xiaomi\" model_name: \"Poco F5 Pro\". The exclusions are merged ones, like OnePlus, as calling those BBK OnePlus is really weird in the respective communities. Note: You will get only a shortened device object with this method, if you want to get a full one, use \"/device/<device_id>\" or \"/device/get\" method instead.
### Parameters
Name | Type | Description | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | Option<[**Vec<String>**](String.md)> | Filter by Device IDs | |
**_id** | Option<[**Vec<String>**](String.md)> | Filter by Device IDs (deprecated) | |
**oem_name** | Option<[**Vec<String>**](String.md)> | Filter by OEM names | |
**codename** | Option<[**Vec<String>**](String.md)> | Filter by device codenames | |
**model_name** | Option<[**Vec<String>**](String.md)> | Filter by model names | |
**supported** | Option<**bool**> | Supported status | |
**maintainer** | Option<[**Vec<String>**](String.md)> | Filter by maintainer ID | |
**freezed** | Option<**bool**> | Filter by Freezed status | |
**has_releases** | Option<**bool**> | Filter by has releases status | |
**skip** | Option<**i32**> | Skip query results | |
**limit** | Option<**i32**> | Limit query results (0 means unlimited) | |
### Return type
[**models::ListResponseShortDeviceResponse**](ListResponse_ShortDeviceResponse_.md)
### Authorization
No authorization required
### 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)
## get_oems
> models::ListResponseStr get_oems()
Get Oems
Lists all OEM names
### Parameters
This endpoint does not need any parameter.
### Return type
[**models::ListResponseStr**](ListResponse_str_.md)
### Authorization
No authorization required
### 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)