Skip to content

Commit e0a93a9

Browse files
committed
Update README.md
1 parent 484f96c commit e0a93a9

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You'll need an IPinfo API access token, which you can get by signing up for a fr
1515

1616
The free plan is limited to 50,000 requests per month, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing)
1717

18-
⚠️ Note: This library does not currently support our newest free API https://ipinfo.io/lite. If you’d like to use IPinfo Lite, you can call the [endpoint directly](https://ipinfo.io/developers/lite-api) using your preferred HTTP client. Developers are also welcome to contribute support for Lite by submitting a pull request.
18+
The library also supports the Lite API, see the [Lite API section](#lite-api) for more info.
1919

2020
### Installation
2121

@@ -150,6 +150,24 @@ app.use(ipinfo({
150150
}))
151151
```
152152

153+
### Lite API
154+
155+
The library gives the possibility to use the [Lite API](https://ipinfo.io/developers/lite-api) too, authentication with your token is still required.
156+
157+
The IP details returned are slightly different from the Core API middleware, though the arguments are identical.
158+
159+
```typescript
160+
const { ipinfoLite } = require('ipinfo-express')
161+
162+
ipinfoLite({
163+
token: "<token>",
164+
cache: <cache_class>,
165+
timeout: 5000,
166+
ipSelector: null
167+
});
168+
```
169+
170+
153171
### Other Libraries
154172

155173
There are official IPinfo client libraries available for many languages including PHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails, and Laravel. There are also many third-party libraries and integrations available for our API.

0 commit comments

Comments
 (0)