Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Kwabang authored Jan 2, 2021
1 parent f0e9a00 commit 1150992
Showing 1 changed file with 54 additions and 1 deletion.
55 changes: 54 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,54 @@
maxmind-self-api
# Maxmind-Self-API <img src="https://img.shields.io/static/v1?label=code&message=Node.js&color=green" alt="">

## Query
- [ASN](#ASN)
- [Country](#Country)
- [City](#City)
- [Geolocation (ASN,Country,City integrated query)](#Geolocation)

### ASN
### Requests
```http
GET /asn/<Query_IP>
```
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `Query_IP` | `string` | IP for query |


### Country
### Requests
```http
GET /country/<Query_IP>
```
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `Query_IP` | `string` | IP for query |

### City
### Requests
```http
GET /city/<Query_IP>
```
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `Query_IP` | `string` | IP for query |

### Geolocation
### Requests
```http
GET /geolocation/<Query_IP>
```
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `Query_IP` | `string` | IP for query |

### Status Codes
| Status Code | Description |
| :--- | :--- |
| 200 | information exists in Maxmind DB |
| 404 | Non-existent path |
| 422 | No information exists in Maxmind DB |

### How to download database
https://dev.maxmind.com/geoip/geoip2/geolite2/#Access

0 comments on commit 1150992

Please sign in to comment.