API Accessibility | Looking for Feedback: `/v1/eligible_applicants` API Endpoint Feature

Hi everyone,

I’ve been hacking away at the grants codebase and came across something which could potentially increase the API accessibility in the client.

Currently as for the frontend React client searchForOpportunities must be called in order to retrieve any data related to:

  • Funding instrument
  • Eligibility
  • Category

However, what if a client wants exclusively a list of eligible client types without having to go through the flow of calling /v1/opportunities/search? There is no functionality for that without using the provided searchForOpportunities callback. Which requires an extensive amount of parameters not needed for such a simple query directed at a particular collection of data (ApplicantType) and also returns back opportunities (not needed in the current context).

I propose that each of these categories listed should be split into there own API endpoints to let users have fine grained control of how they would like to setup filters for their own analysis of finding grants.

Each endpoint should return the entirety of their table within the database due to how small each table is. (e.g. in lk_opportunity_category there are only 17 entries… even in production)

As for now I have added an API endpoint for querying the lkApplicantType in the Flask API and am looking to create the typescript bindings.

Let me know what your thoughts are!

Showcase:

1 Like

This is excellent feedback. We will discuss it internally with the engineering team and get back to you with our thoughts. Thank you for bringing it to our attention.

1 Like