# OkeyProxy API

## Docs

- [Error Codes](https://docs.okeyproxy.com/Troubleshooting.md): Global and endpoint-specific error codes for the OkeyProxy Agent API
- [Check available countries for specified continent](https://docs.okeyproxy.com/api-reference/endpoint/2.md): Returns the list of countriesfrom which IPs can be extracted under the current plan in specified continent.
- [Create sec-user account](https://docs.okeyproxy.com/api-reference/endpoint/Create.md): Create a new sec-user account.
- [Disable sec-user account](https://docs.okeyproxy.com/api-reference/endpoint/Disable.md): Disable specified sec-user.
- [Edit sec-user account](https://docs.okeyproxy.com/api-reference/endpoint/Edit.md): Update password and remarks of specific sec-user.
- [Enable sec-user account](https://docs.okeyproxy.com/api-reference/endpoint/Enable.md): Enable specified sec-user.
- [Assign plan to sec-user](https://docs.okeyproxy.com/api-reference/endpoint/addPlan.md): Assign a rotating proxies plan to the specified sec-user.
- [Check available cities](https://docs.okeyproxy.com/api-reference/endpoint/cities.md): Returns the list of cities from which IPs can be extracted under the current plan in specified region.
- [Generate customized endpoints for continent](https://docs.okeyproxy.com/api-reference/endpoint/continent.md): Generate custom proxy endpoints with protocol, location, session type, and sticky session duration.
- [Check available continents](https://docs.okeyproxy.com/api-reference/endpoint/continents.md): Returns the list of continents from which IPs can be extracted under the current plan.
- [Check available countries](https://docs.okeyproxy.com/api-reference/endpoint/countries.md): Returns the list of countries from which IPs can be extracted under the current plan.
- [Generate customized endpoints](https://docs.okeyproxy.com/api-reference/endpoint/custom.md): Generate custom proxy endpoints with protocol, location, session type, and sticky session duration.
- [Get default endpoints](https://docs.okeyproxy.com/api-reference/endpoint/default.md): Check default proxy endpoints for a specific plan type.
- [Assign plan with details](https://docs.okeyproxy.com/api-reference/endpoint/details.md): Assign a rotating proxies plan to the specified sec-user and return details.
- [Query sec-user information](https://docs.okeyproxy.com/api-reference/endpoint/information.md): Query specific sec-user account information.
- [Get sec-user list](https://docs.okeyproxy.com/api-reference/endpoint/list.md): Get a list of active sec-users.
- [Get sec-user history](https://docs.okeyproxy.com/api-reference/endpoint/listHistory.md): Get a list of all sec-users, including disabled accounts.
- [Retrieve API logs](https://docs.okeyproxy.com/api-reference/endpoint/logs.md): Retrieve API call logs by API key and time range.
- [Get plan information](https://docs.okeyproxy.com/api-reference/endpoint/planinfo.md): Query information for a specific plan under the agent.
- [Retrieve agent plan list](https://docs.okeyproxy.com/api-reference/endpoint/planlist.md): Retrieve all plans under the specified agent, filtered by expiration time window (startTime to endTime, UTC+8).
- [Check available regions](https://docs.okeyproxy.com/api-reference/endpoint/regions.md): Returns the list of regions from which IPs can be extracted under the current plan in specified country.
- [OkeyProxy Agent API Introduction](https://docs.okeyproxy.com/api-reference/introduction.md): API reference for managing sec-user accounts and rotating proxy plans via OkeyProxy Agent API

## OpenAPI Specs

- [openapi](https://docs.okeyproxy.com/api-reference/openapi.json)

## Optional

- [Blog](https://www.okeyproxy.com/en/blog-category)