YardCode API Documentation

Integrate YardCode's powerful location service into your applications and enhance your digital address experience. Our API enables seamless conversion between yard codes and geographic coordinates, providing precise location data for Nigerian businesses and developers.

YardCode simplifies navigation, logistics, and location-based services by providing unique codes for every location in Nigeria. With our API, you can bring this revolutionary technology to your users.

Get Your API Key

For as low as N6,000, access our powerful YardCode API to convert between yard codes and geographic coordinates. Enhance your applications with precise location data.

  • Precise conversion between geographic coordinates and YardCodes
  • Simple, RESTful API integration
  • Technical support included
  • Comprehensive documentation and examples

How to Use the API

The YardCode API is designed for easy integration with clear endpoints for all your location needs.

1. Validate YardCode (FREE)

GET https://www.yardcode.ng/api/validate?yard_code=JM14W37polo

2. Convert YardCode to Coordinates (1 unit per Call)

GET https://www.yardcode.ng/api/y2c/{your_api_key}?yard_code=AB12C34Koso

3. Convert Coordinates to YardCode (1 unit per Call)

GET https://www.yardcode.ng/api/c2y/{your_api_key}?latitude=9.0765&longitude=7.3986

Or using UTM coordinates:

GET https://www.yardcode.ng/api/c2y/{your_api_key}?easting=123456.78&northing=987654.32&zone_number=31&northern=1

4. Convert Street Address to YardCode (5 units per Call)

GET https://www.yardcode.ng/api/s2y/{your_api_key}?address=123 Victoria Island Lagos

5. Convert YardCode to Street Address (5 units per Call)

GET https://www.yardcode.ng/api/y2s/{your_api_key}?yard_code=AB12C34Koso

Or using coordinates:

GET https://www.yardcode.ng/api/y2s/{your_api_key}?latitude=9.0765&longitude=7.3986

6. Bulk YardCode to Coordinates (n units per Call)

GET https://www.yardcode.ng/api/by2c/{your_api_key}?yard_code=AG67T34sovo,DC3P79vola,WP6Y5

7. Bulk Coordinates to YardCode

GET https://www.yardcode.ng/api/bc2y/{your_api_key}?latitude=10.09865,9.53455&longitude=7.35986,6.32223

Or using UTM coordinates:

GET https://www.yardcode.ng/api/bc2y/{your_api_key}?easting=123456,654321&northing=987654,456789&zone_number=31,32&northern=1,1

Example Response (Address to YardCode):

{ "status": "success", "data": { "input_address": "123 Victoria Island Lagos", "formatted_address": "123 Victoria Island, Lagos, Nigeria", "confidence_level": "high", "suggestions": [], "latitude": 6.4281, "longitude": 3.4219, "yard_code": "HY4 L76", "spot": "polo", "state": "Lagos State", "status": "Successful", "easting": 123456.78, "northing": 987654.32, "zone_number": 31, "northern": 1, "calls_left": 999 } }

Example Response (YardCode to Address):

{ "status": "success", "data": { "yard_code": "GQ9 U88 luvi", "latitude": 6.4281, "longitude": 3.4219, "formatted_address": "20 Oba Adesida Road, Ibadan, Oyo State, Nigeria", "state": "Oyo State", "status": "Successful", "easting": 123456.78, "northing": 987654.32, "zone_number": 31, "northern": 1, "calls_left": 999 } }

Manage Your Subscription

Already have an API key? Manage your existing subscription or make additional payments to ensure uninterrupted service.

  • Check your current API usage
  • View payment history
  • Renew your subscription before expiry
  • Upgrade to higher API call volumes
  • Access technical support

Benefits of Renewing Early:

  • No interruption in service
  • Priority support for your integration
  • Access to new features as they roll out