Skip to content

OpenSourceNepal API Documentation

🏠 Visit https://givingback.ai to learn more.

Overview

Welcome to the OpenSourceNepal API documentation. This API provides endpoints to access various data related to Economics, Address, Public Institutions, and Utilities.

Base URL

https://api.givingback.ai/opensourcenepal

Economics API

Payment Systems Directory

  • Retrieve the directory for payment systems in Nepal. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/paymentSystemsDirectory

Curl:

curl -X 'GET' \
'https://api.givingback.ai/e/paymentSystemsDirectory' \
-H 'accept: application/json'

Request Format

json { "data": [] }

Response Format

json { "data": [] }

Budgets

  • Retrieve info about budget distribution over the years. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/budgets
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/budgets?per_page=10&page=0' \
-H 'accept: application/json'

Request Format

  • Query Params:
  • per_page: int
  • page: int

Response Format

[
{
"category_id": 0,
"published_date": "string",
"revised_estimate_date": "string",
"estimate_year_str": "string",
"estimate_year_start_ad": 0,
"estimate_year_end_ad": 0,
"estimate_amount": "string",
"source_type_id": "string",
"description": "string",
"country": "string",
"currency": "string",
"amount": 0,
"source": "string"
}
]

Forex

  • Retrieve the directory for payment systems in Nepal. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/forex
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/forex?limit=10&offset=0' \
-H 'accept: application/json'

Request Format

  • Query Params:
  • per_page: int
  • page: int

Response Format

[
{
"id": 0,
"country_name": "",
"currency": "string",
"forex_millions": 0,
"forex_gross_millions": 0,
"fiscal_year_str": "string",
"fiscal_year": "2024-07-14",
"month": "string"
}
]

Imports

  • Retrieve the directory for payment systems in Nepal. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/imports
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/imports?per_page=10&page=1' \
-H 'accept: application/json'

Request Format

  • Query Params:
  • per_page: intt
  • page: int

Response Format

{
"data": []
}

Export

  • Retrieve data about the exports history of Nepal. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/paymentSystemsDirectory
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/exports?limit=10&offset=0' \
-H 'accept: application/json'

Request Format

  • Query Params:
  • per_page: int
  • page: int

Response Format

[
{
"id": 0,
"hs_code": "string",
"parent_hs_code": "string",
"commodity_name": "string",
"export_from": "string",
"unit": "string",
"amount": 0,
"currency": "string",
"report_year": "string",
"source": "string"
}
]

Remittances

  • Retrieve data about the remittance history of Nepal. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/paymentSystemsDirectory
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/remittances?limit=10&offset=0' \
-H 'accept: application/json'

Request Format

- Query Params:
- `per_page`: int
- `page`: int

Response Format

[
{
"id": 0,
"country_name": "string",
"currency": "string",
"remittance_type": "string",
"rolling_amount_monthly_millions": 0,
"amount_monthly_millions": 0,
"fiscal_year": "string",
"month_english": "string",
"month_num_english": "string",
"month_nepali": "string",
"source": "string"
}
]

Address API

Administrative Units

  • Retrieve a list of economic indicators. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/administrativeUnit
Curl:

Request Format

{
"data": []
}

Response Format

{
"data": []
}

Public Institutions API

Schools

  • Retrieve the details of schools of Nepal. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/paymentSystemsDirectory
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/schools?school_search=school&limit=1000&offset=0' \
-H 'accept: application/json'

Request Format

  • Query Params:
  • school_search: str
  • per_page: int
  • page: int

Response Format

[
{
"school_id": 0,
"school_name": "",
"province": "string",
"district": "string",
"municipality_name": "string",
"municipality_type": "string",
"ward_number": 0
}
]

Utilities API

Nepali DateTime

  • Retrieve current date, time, and tithi for Nepal. !!! important "Method: GET"

URL

{{BAASE_URL}}/e/nepaliDateTime
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/nepaliDateTime' \
-H 'accept: application/json'

Request Format

{
"data": []
}

Response Format

{
"data": []
}

Exception Logger

  • Log exceptions and errors for your subscribed application. !!! important "Method: POST"

URL

{{BAASE_URL}}/e/logger
Curl: 
curl -X 'GET' \
'https://api.givingback.ai/e/nepaliDateTime' \
-H 'accept: application/json'

Request Format

{
"customer_id": 0,
"exception_message": "string",
"service_name": "string",
"created_date": "2024-05-07T05:27:18.899347",
"additional_info": "string"
}

Response Format

{
"customer_id": 0,
"exception_message": "string",
"service_name": "string",
"created_date": "2024-05-07T05:27:18.899347",
"additional_info": "string"
}

In this example, each section (Economics API, Address API, etc.) includes multiple tabs for different programming languages (curl, Python, JavaScript). When rendered with a compatible Markdown renderer (like MkDocs with appropriate plugins), these tabs will appear as selectable tabs for users viewing your documentation. Adjust the placeholders (YOUR_API_KEY, endpoints, etc.) with your actual API details and endpoints as needed.