Litport API
Public free-proxy retrieval, authenticated account operations (tokens, usage, packages, and pay-per-GB), and a support conversation API. Pay-per-GB proxies…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Public free-proxy retrieval, authenticated account operations (tokens, usage, packages, and pay-per-GB), and a support conversation API. Pay-per-GB proxies can be created, changed, and deleted; a package's proxies can only be relabelled, and have their credentials reissued. A typical use is one pay-per-GB proxy per end customer, each with its own traffic cap and expiry, with usage read for many proxies at once.
Endpoints 28
Support
- POSTStart a support conversation
/api/v1/support/conversationsStarts a conversation with Litport support and posts the first message. Without an Authorization header this creates a guest conversation: email is required,… - POSTAdd a message to a support conversation
/api/v1/support/conversations/:conversationId/messagesSend an account API key (lit_…) or the conversation's access token (lsc_…) as Authorization: Bearer …; both use the same header. The credential must open this… - GETRead a support conversation
/api/v1/support/conversations/:conversationIdReturns the messages after after, oldest first, and the state of the conversation. Poll every pollAfterSeconds (30). Send an account API key (lit_…) or the…
- GETList public free proxies
/api/free-proxyReturns a bare array. Invalid numeric and sort inputs currently fall back to defaults instead of returning 400. - GETRetrieve one consistent fresh free-proxy snapshot
/api/free-proxy/snapshotReturns the whole matching live dataset in one response. checkedWithinMin defaults to 30 and invalid values return 400. - GETList the caller's existing tokens
/api/v1/tokensReturns customer-visible metadata and credentials for the caller's existing tokens. A paged list; see the packageId filter and the shared pagination rule. - POSTCreate a pay-per-GB proxy
/api/v1/tokensBearer key only. The body must be a JSON object, {} at the least; a request with no body creates nothing. The answer is 201 and the proxy as GET… - GETRead one owned token
/api/v1/tokens/:tokenIdReturns the identical customer-visible shape as a matching element of GET /tokens, including proxy credentials. - DELETEDelete a pay-per-GB proxy
/api/v1/tokens/:tokenIdBearer key only. No request body. The proxy stops working and its open connections close. Its history stays: GET /usage still lists it, marked deleted, and… - PATCHChange a proxy
/api/v1/tokens/:tokenIdNo precondition header is required or honored. The latest committed, successful write becomes the new state; the latest write always wins. 409… - POSTReissue a proxy's credentials
/api/v1/tokens/:tokenId/credentialsBearer key only. Issues a new username, password and change-IP key for any proxy the account owns, pay-per-GB or package. The answer is the proxy as GET… - GETRead usage for many proxies
/api/v1/usageThe usage of many of the account's proxies over one date range, per proxy per day, newest proxy first, paged with limit and cursor. Deleted proxies are… - GETRead usage for one owned token
/api/v1/tokens/:tokenId/usageA deleted token still answers, with deleted: true, so a customer's last bill can be read after the proxy is gone. - GETRead one token's saved and effective location
/api/v1/tokens/:tokenId/location - PUTChoose a movable token's location (datacenter/ISP region+city, or mobile city+carrier)
/api/v1/tokens/:tokenId/locationNo precondition header is required or honored. The latest committed, successful write becomes the new state; the latest write always wins. 409… - POSTMove a static datacenter/ISP token back to its saved location
/api/v1/tokens/:tokenId/location/returnNo request body (an empty {} is accepted). Static datacenter and ISP tokens only; any other token, or one with no saved location, answers 409 NOT_SUPPORTED.… - GETList the values currently usable for a token's next location field
/api/v1/tokens/:tokenId/location/options?level=regionA complete list: every currently usable option, always with page.nextCursor: null. - PUTChange a rotating token's rotation interval
/api/v1/tokens/:tokenId/rotationNo precondition header is required or honored. The latest committed, successful write becomes the new state; the latest write always wins. 409… - POSTGet a new IP in the same location (datacenter/ISP)
/api/v1/tokens/:tokenId/new-ipNo request body. Datacenter and ISP tokens only; any other token answers 409 NOT_SUPPORTED. The new IP stays in the token's saved location. A token whose… - GETList owned proxy packages
/api/v1/packages - GETRead one owned proxy package
/api/v1/packages/:packageId - GETRead a package's allowed-IP list
/api/v1/packages/:packageId/allowed-ips - PUTSet a package's whole allowed-IP list
/api/v1/packages/:packageId/allowed-ipsNo precondition header is required or honored. The latest committed, successful write becomes the new state; the latest write always wins. 409… - PUTAdd one IP to a package's allowed-IP list
/api/v1/packages/:packageId/allowed-ips/:ipNo precondition header is required or honored. The latest committed, successful write becomes the new state; the latest write always wins. 409… - DELETERemove one IP from a package's allowed-IP list
/api/v1/packages/:packageId/allowed-ips/:ipNo precondition header is required or honored. The latest committed, successful write becomes the new state; the latest write always wins. 409… - GETList customer-selectable pay-per-GB pools
/api/v1/pay-per-gb/poolsA complete list: every selectable pool, priced at the account's current plan discount, with its usable hubs and supported geo levels. Always page.nextCursor:… - GETDiscover geo targeting values for one or more pay-per-GB pools
/api/v1/pay-per-gb/geo?pool=string&level=countryA paged list: the country, region, or city values every requested pool supports, selecting pools by authKey. - GETRead account balance and plan
/api/v1/pay-per-gb/balanceReturns the authenticated account's current billing balance and plan, to explain an insufficient-balance proxy error.
API details
- Base URL
https://litport.net- Authentication
- A bearer token in the Authorization header
- Operations
- 28 operations on 22 pathsGET 15POST 6PUT 4DELETE 2PATCH 1
- Main resources
- Support 3
- Response formats
application/jsontext/csvtext/plain- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- Litport's published OpenAPI description
How to test the Litport API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Litport API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Start a support conversation” (POST /api/v1/support/conversations), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Litport API?
Public free-proxy retrieval, authenticated account operations (tokens, usage, packages, and pay-per-GB), and a support conversation API. Pay-per-GB proxies… It is listed under Developer tools and has 28 endpoints.
Who publishes the Litport API?
It is listed from Litport's public API description (an OpenAPI document), not published by Litport on Swastik Codes. Anyone who controls litport.net can claim the profile by adding a DNS TXT record.
What is the base URL of the Litport API?
Requests go to https://litport.net. Endpoint paths are added to this base URL.
How do I authenticate with the Litport API?
With A bearer token in the Authorization header.
How many endpoints does the Litport API have?
28 operations on 22 paths (15 GET, 6 POST, 4 PUT, 2 DELETE, 1 PATCH). The largest groups are Support.
Is forking the Litport API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.