# Today List API

## Forward request

> Forwards a request to a specified proxy ID and port.

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"paths":{"/api/forward":{"get":{"summary":"Forward request","description":"Forwards a request to a specified proxy ID and port.","parameters":[{"schema":{"type":"string"},"name":"id","in":"query","description":"Proxy ID to forward the request to."},{"schema":{"type":"string"},"name":"port","in":"query","description":"Port number for the forwarding request."},{"schema":{"type":"string"},"name":"plan","in":"query","description":"Plan type for forwarding (default is '1' if not provided)."},{"schema":{"type":"string"},"name":"t","in":"query","description":"Response type 1=txt, 2=json"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseBase"}}}},"400":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseMessage"}}}},"402":{"description":"Insufficient balance response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseMessage"}}}},"404":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseMessage"}}}},"406":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseMessage"}}}}}}}},"components":{"schemas":{"ResponseBase":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."},"data":{"type":"array","items":{"type":"string"},"description":"List of returned proxies."}}},"ResponseMessage":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."}}}}}}
```

## Get today's proxy list

> Returns a list of proxies that are available today based on query filters.

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"paths":{"/api/today_list":{"get":{"summary":"Get today's proxy list","description":"Returns a list of proxies that are available today based on query filters.","parameters":[{"schema":{"type":"string"},"name":"country","in":"query","description":"Country code (e.g., US, VN)."},{"schema":{"type":"string"},"name":"state","in":"query","description":"State or province of the proxy."},{"schema":{"type":"string"},"name":"city","in":"query","description":"City where the proxy is located."},{"schema":{"type":"string"},"name":"zip","in":"query","description":"Postal code of the proxy location."},{"schema":{"type":"string"},"name":"isp","in":"query","description":"Internet Service Provider (ISP)."},{"schema":{"type":"integer"},"name":"limit","in":"query","description":"Maximum number of proxies to retrieve."},{"schema":{"type":"string"},"name":"t","in":"query","description":"Response type 1=txt, 2=json"}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResponseTodayList"}}}}}}}},"components":{"schemas":{"ResponseTodayList":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProxyInfo"},"description":"List of proxies available today."}}},"ProxyInfo":{"type":"object","description":"Details of an available proxy.","properties":{"id":{"type":"string","description":"Unique identifier of the proxy."},"city":{"type":"string","description":"City where the proxy is located."},"ip":{"type":"string","description":"IP address of the proxy."},"country_code":{"type":"string","description":"Country code of the proxy location."},"is_online":{"type":"boolean","description":"Indicates whether the proxy is online (true) or offline (false)."},"binding":{"type":["string","null"],"description":"Binding information, if applicable."}}}}}}
```

## The ProxyInfo object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"ProxyInfo":{"type":"object","description":"Details of an available proxy.","properties":{"id":{"type":"string","description":"Unique identifier of the proxy."},"city":{"type":"string","description":"City where the proxy is located."},"ip":{"type":"string","description":"IP address of the proxy."},"country_code":{"type":"string","description":"Country code of the proxy location."},"is_online":{"type":"boolean","description":"Indicates whether the proxy is online (true) or offline (false)."},"binding":{"type":["string","null"],"description":"Binding information, if applicable."}}}}}}
```

## The ResponseTodayList object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"ResponseTodayList":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."},"data":{"type":"array","items":{"$ref":"#/components/schemas/ProxyInfo"},"description":"List of proxies available today."}}},"ProxyInfo":{"type":"object","description":"Details of an available proxy.","properties":{"id":{"type":"string","description":"Unique identifier of the proxy."},"city":{"type":"string","description":"City where the proxy is located."},"ip":{"type":"string","description":"IP address of the proxy."},"country_code":{"type":"string","description":"Country code of the proxy location."},"is_online":{"type":"boolean","description":"Indicates whether the proxy is online (true) or offline (false)."},"binding":{"type":["string","null"],"description":"Binding information, if applicable."}}}}}}
```

## The PortStats object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"PortStats":{"type":"object","description":"Details of a port's status.","properties":{"port":{"type":"integer","description":"The port number being checked."},"online":{"type":"boolean","description":"Indicates whether the port is online (true) or offline (false)."}}}}}}
```

## The ResponseCheckStatus object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"ResponseCheckStatus":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortStats"},"description":"List of port status details."}}},"PortStats":{"type":"object","description":"Details of a port's status.","properties":{"port":{"type":"integer","description":"The port number being checked."},"online":{"type":"boolean","description":"Indicates whether the port is online (true) or offline (false)."}}}}}}
```

## The PortInfo object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"PortInfo":{"type":"object","description":"Details of a port's status.","properties":{"address":{"type":"string","description":"The address associated with the port."},"city":{"type":"string","description":"The city where the port is located."},"public_ip":{"type":"string","description":"The public IP address of the port."},"online":{"type":"boolean","description":"Indicates whether the port is online (true) or offline (false)."}}}}}}
```

## The ResponsePortStatus object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"ResponsePortStatus":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."},"data":{"type":"array","items":{"$ref":"#/components/schemas/PortInfo"},"description":"List of port status details."}}},"PortInfo":{"type":"object","description":"Details of a port's status.","properties":{"address":{"type":"string","description":"The address associated with the port."},"city":{"type":"string","description":"The city where the port is located."},"public_ip":{"type":"string","description":"The public IP address of the port."},"online":{"type":"boolean","description":"Indicates whether the port is online (true) or offline (false)."}}}}}}
```

## The ResponseMessage object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"ResponseMessage":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."}}}}}}
```

## The ResponseBase object

```json
{"openapi":"3.1.1","info":{"title":"Today List API","version":"1.0"},"components":{"schemas":{"ResponseBase":{"type":"object","description":"API response format.","properties":{"error":{"type":"boolean","description":"Error status (true if an error occurred, false if successful)."},"message":{"type":"string","description":"Response message."},"data":{"type":"array","items":{"type":"string"},"description":"List of returned proxies."}}}}}}
```