Skip to content

Commit

Permalink
change codeblock to js format
Browse files Browse the repository at this point in the history
  • Loading branch information
kerv14 committed Mar 7, 2024
1 parent a43f87e commit c534105
Show file tree
Hide file tree
Showing 17 changed files with 17 additions and 17 deletions.
2 changes: 1 addition & 1 deletion docs/docs/methods/bulk-postcode-lookup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Be sure to submit JSON requests setting `Content-Type` to `application/json`

Accepts up to 100 postcodes.

```POST
```javascript
POST https://api.postcodes.io/postcodes/
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/bulk-reverse-geocoding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Bulk Reverse Geocoding"

Bulk translates geolocations into Postcodes. Accepts up to 100 geolocations.

```get
```javascript
POST https://api.postcodes.io/postcodes
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/nearest-outcode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Nearest Outcode"

Returns nearest outcodes for a given outcode.

```get
```javascript
GET https://api.postcodes.io/outcodes/:outcode/nearest
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/nearest-postcode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Nearest Postcode"

Returns nearest postcodes for a given postcode.

```get
```javascript
GET https://api.postcodes.io/postcodes/:postcode/nearest
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/outcode-reverse-geocoding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Outcode Reverse Geocoding"

Returns nearest outcodes for a given longitude and latitude.

```get
```javascript
GET https://api.postcodes.io/outcodes?lon=:longitude&lat=:latitude
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/outward-code-lookup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: "Outcode Lookup"

Geolocation data for the centroid of the outward code specified. The outward code represents the first half of any postcode (separated by a space).

```get
```javascript
GET https://api.postcodes.io/outcodes/:outcode
```
2 changes: 1 addition & 1 deletion docs/docs/methods/place-lookup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: "Place Lookup"

Find a place by OSGB code (e.g. "osgb4000000074564391"). Returns all available data if found. Returns 404 if place does not exist.

```get
```javascript
GET https://api.postcodes.io/places/:code
```
2 changes: 1 addition & 1 deletion docs/docs/methods/place-query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Place Query"

Submit a place query and receive a complete list of places matches and associated data.

```get
```javascript
GET https://api.postcodes.io/places?q=[query]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/postcode-autocomplete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Postcode Autocomplete"

Convenient method to return an list of matching postcodes.

```get
```javascript
GET https://api.postcodes.io/postcodes/:postcode/autocomplete
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/postcode-lookup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Returns a single postcode entity for a given postcode (case, space insensitive).

If no postcode is found it returns "404" response code.

```get
```javascript
GET https://api.postcodes.io/postcodes/:postcode
```
2 changes: 1 addition & 1 deletion docs/docs/methods/postcode-query.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This method is space sensitive, i.e. it detects for spaces between outward and i

The result set can either be empty or populated with up to 100 postcode entities. Either way it will always return a 200 response code

```get
```javascript
GET https://api.postcodes.io/postcodes?q=[query]
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/postcode-validation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Postcode Lookup"

Convenience method to validate a postcode. Returns true or false (meaning valid or invalid respectively)

```get
```javascript
GET https://api.postcodes.io/postcodes/:postcode/validate
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/random-place.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: "Random Place"

Returns a random place and all associated data

```get
```javascript
GET https://api.postcodes.io/random/places
```
2 changes: 1 addition & 1 deletion docs/docs/methods/random-postcode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Random Postcode"

Returns a random postcode and all available data for that postcode.

```get
```javascript
GET https://api.postcodes.io/random/postcodes
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/reverse-geocoding.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: "Reverse Geocoding"

Returns nearest postcodes for a given longitude and latitude.

```get
```javascript
GET https://api.postcodes.io/postcodes?lon=:longitude&lat=:latitude
```

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/methods/scottish-postcode-lookup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Lookup a Scottish postcode. Returns SPD data associated with postcode. At the mo

Returns 404 if postcode does not exist in SPD or is not valid. For postcodes not in SPD but in ONSPD, 404 is returned with error message `Postcode exists in ONSPD but not in SPD`.

```get
```javascript
GET https://api.postcodes.io/scotland/postcodes/:postcode
```
2 changes: 1 addition & 1 deletion docs/docs/methods/terminated-postcode-lookup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ title: "Terminated Postcode Lookup"

Lookup a terminated postcode. Returns the postcode, year and month of termination. Returns 404 if postcode does not exist in our database of terminated postcodes or not valid.

```get
```javascript
GET https://api.postcodes.io/terminated_postcodes/:postcode
```

0 comments on commit c534105

Please sign in to comment.