Add Fundraising API: Org and Projects endpoints (#14)

* Add fundraising yaml

* Update client for fund raising

* Add initial fund raising examples

* Add m&a endpoint

* Extend example

* Gen types

* Lint

* Add organization and projects endpoints

* Update client

* Update examples and types

* Fix imports

* Update readme

Author: danielkhoo

README.md

@@ -55,7 +55,13 @@ const entities = await client.ai.extractEntities({
 | Asset | Asset List | `/asset/v1/assets` | ✅ |
 | Asset | Asset By ID | `/asset/v1/assets/{assetId}` | ❌ |
 | |
-| Intel | TODO | `/intel/v1/events` | ✅ |
+| Intel | Events | `/intel/v1/events` | ✅ |
+| Intel | Events By ID | `/intel/v1/events/{eventId}` | ✅ |
+| Intel | Intel Assets | `/intel/v1/assets` | ✅ |
+| |
+| News | News Assets | `/news/v1/news/assets` | ✅ |
+| News | News Feed | `/news/v1/news/feed` | ✅ |
+| News | News Sources | `/news/v1/news/sources` | ✅ |
 | |
 | Marketdata | Marketdata by AssetID | `/marketdata/v1/assets/{assetId}/price` | ✅ |
 | Marketdata | ROI | `/marketdata/v1/assets/roi` | ✅ |
@@ -70,7 +76,22 @@ const entities = await client.ai.extractEntities({
 | Marketdata | Exchanges | `/marketdata/v1/exchanges` | ❌ |
 | Marketdata | Volume Timeseries by ExchangeID | `/marketdata/v1/exchanges/{exchangeId}/volume/time-series` | ❌ |
 | |
-| News | TODO | `/news/v1/news/assets` | ✅ |
+| AI Digest | Project Recap By ID | `/ai-digest/api/v1/recap` | ✅ |
+| AI Digest | Exchange Recaps Overview | `/ai-digest/api/v1/exchange-rankings-recap` | ✅ |
+| AI Digest | Exchange Recap By ID | `/ai-digest/api/v1/exchange-recap` | ✅ |
+| |
+| Research | Reports | `/research/v1/reports` | ✅ |
+| Research | Report By ID | `/research/v1/reports/{id}` | ✅ |
+| Research | Report Tags | `/research/v1/reports/tags` | ✅ |
+| |
+| Diligence | Report Preview | `/diligence/v1/reports/preview` | ✅ |
+| Diligence | Report By Asset ID | `/diligence/v1/report/asset/{assetId}` | ✅ |
+| |
+| Fundraising | Funding Rounds | `/funding/v1/rounds` | ✅ |
+| Fundraising | Funding Rounds Investors | `/funding/v1/rounds/investors` | ✅ |
+| Fundraising | Mergers and Acquisitions | `/funding/v1/mergers-and-acquisitions` | ✅ |
+| Fundraising | Organizations | `/funding/v1/organizations` | ✅ |
+| Fundraising | Projects | `/funding/v1/projects` | ✅ |
 
 
 

packages/api/src/client/base.ts

@@ -44,7 +44,8 @@ import type {
   getFundingRoundsInvestorsParameters,
   Investors,
   getAcquisitionDealsParameters,
-  AcquisitionDeal,
+  Organization,
+  Project,
   getTokenUnlockSupportedAssetsParameters,
   getTokenUnlockSupportedAssetsResponse,
   getTokenUnlockAllocationsParameters,
@@ -55,6 +56,9 @@ import type {
   getTokenUnlocksResponse,
   getTokenUnlockEventsParameters,
   getTokenUnlockEventsResponse,
+  AcquisitionDeal,
+  getOrganizationsParameters,
+  getProjectsParameters,
 } from "@messari-kit/types";
 import { LogLevel, type Logger, makeConsoleLogger, createFilteredLogger, noOpLogger } from "../logging";
 import type { PaginatedResult, RequestOptions, ClientEventMap, ClientEventType, ClientEventHandler } from "./types";
@@ -287,6 +291,18 @@ export interface FundraisingAPIInterface {
    * @param params Query parameters for filtering acquisition deals
    */
   getAcquisitionDeals(params?: getAcquisitionDealsParameters): Promise<APIResponseWithMetadata<AcquisitionDeal[]>>;
+
+  /**
+   * Gets a list of all organizations based on provided filters
+   * @param params Query parameters for filtering organizations
+   */
+  getOrganizations(params?: getOrganizationsParameters): Promise<APIResponseWithMetadata<Organization[]>>;
+
+  /**
+   * Gets a list of all projects based on provided filters
+   * @param params Query parameters for filtering projects
+   */
+  getProjects(params?: getProjectsParameters): Promise<APIResponseWithMetadata<Project[]>>;
 }
 
 /**

packages/api/src/client/client.ts

@@ -29,6 +29,8 @@ import {
   getTokenUnlockSupportedAssets,
   getTokenUnlocks,
   getTokenUnlockVestingSchedule,
+  getOrganizations,
+  getProjects,
 } from "@messari-kit/types";
 import type {
   createChatCompletionParameters,
@@ -87,6 +89,10 @@ import type {
   getTokenUnlocksResponse,
   getTokenUnlockVestingScheduleParameters,
   getTokenUnlockVestingScheduleResponse,
+  getOrganizationsParameters,
+  getOrganizationsResponse,
+  getProjectsParameters,
+  getProjectsResponse,
 } from "@messari-kit/types";
 import type { Agent } from "node:http";
 import { pick } from "../utils";
@@ -825,8 +831,23 @@ export class MessariClient extends MessariClientBase {
         queryParams: pick(params, getAcquisitionDeals.queryParams),
       });
     },
-  };
 
+    getOrganizations: async (params: getOrganizationsParameters) => {
+      return this.requestWithMetadata<getOrganizationsResponse, PaginationMetadata>({
+        method: getOrganizations.method,
+        path: getOrganizations.path(),
+        queryParams: pick(params, getOrganizations.queryParams),
+      });
+    },
+
+    getProjects: async (params: getProjectsParameters) => {
+      return this.requestWithMetadata<getProjectsResponse, PaginationMetadata>({
+        method: getProjects.method,
+        path: getProjects.path(),
+        queryParams: pick(params, getProjects.queryParams),
+      });
+    },
+  };
   public readonly tokenUnlocks: TokenUnlocksInterface = {
     getSupportedAssets: async (params: getTokenUnlockSupportedAssetsParameters = {}, options?: RequestOptions) => {
       return this.request<getTokenUnlockSupportedAssetsResponse>({

packages/examples/src/fundraising.ts

@@ -1,6 +1,12 @@
 import { MessariClient } from "@messari-kit/api";
 import { printTable } from "console-table-printer";
-import type { getAcquisitionDealsParameters, getFundingRoundsInvestorsParameters, getFundingRoundsParameters } from "@messari-kit/types";
+import type {
+  getAcquisitionDealsParameters,
+  getFundingRoundsInvestorsParameters,
+  getFundingRoundsParameters,
+  getOrganizationsParameters,
+  getProjectsParameters,
+} from "@messari-kit/types";
 import dotenv from "dotenv";
 
 // Load environment variables from .env file
@@ -109,6 +115,46 @@ async function main() {
   } catch (error) {
     console.error("Error calling getAcquisitionDeals:", error);
   }
+
+  // Get the organizations
+  try {
+    const orgsParams: getOrganizationsParameters = { page: 1, limit: 10 };
+    const resp = await client.fundraising.getOrganizations(orgsParams);
+    console.log("\n--------------------------------");
+    console.log("Organizations");
+    console.log("--------------------------------");
+    const orgs = resp.data;
+    if (orgs.length > 0) {
+      const rows = orgs.map((o) => ({
+        "Id": o.id,
+        "Name": o.name,
+        "Location": o.location,
+      }));
+      printTable(rows);
+    }
+  } catch (error) {
+    console.error("Error calling getOrganizations:", error);
+  }
+
+  // Get the projects
+  try {
+    const projectsParams: getProjectsParameters = { page: 1, limit: 10 };
+    const resp = await client.fundraising.getProjects(projectsParams);
+    console.log("\n--------------------------------");
+    console.log("Projects");
+    console.log("--------------------------------");
+    const projects = resp.data;
+    if (projects.length > 0) {
+      const rows = projects.map((p) => ({
+        "Id": p.id,
+        "Name": p.name,
+        "Tags": p.tags?.join(", "),
+      }));
+      printTable(rows);
+    }
+  } catch (error) {
+    console.error("Error calling getProjects:", error);
+  }
 }
 
 main().catch(console.error);

packages/types/src/index.ts

@@ -392,6 +392,36 @@ export const getAcquisitionDeals = {
 } as const;
 
 
+export type getOrganizationsResponse = components['schemas']['Organization'][];
+export type getOrganizationsError = components['schemas']['APIError'];
+
+export type getOrganizationsParameters = { id?: string; category?: string; sector?: string; tags?: string; foundedBefore?: string; foundedAfter?: string; page?: number; limit?: number };
+
+
+export const getOrganizations = {
+  method: 'GET' as const,
+  pathParams: [] as const,
+  queryParams: ['id', 'category', 'sector', 'tags', 'foundedBefore', 'foundedAfter', 'page', 'limit'] as const,
+  bodyParams: [] as const,
+  path: () => '/funding/v1/organizations'
+} as const;
+
+
+export type getProjectsResponse = components['schemas']['Project'][];
+export type getProjectsError = components['schemas']['APIError'];
+
+export type getProjectsParameters = { id?: string; category?: string; sector?: string; tags?: string; foundedBefore?: string; foundedAfter?: string; page?: number; limit?: number };
+
+
+export const getProjects = {
+  method: 'GET' as const,
+  pathParams: [] as const,
+  queryParams: ['id', 'category', 'sector', 'tags', 'foundedBefore', 'foundedAfter', 'page', 'limit'] as const,
+  bodyParams: [] as const,
+  path: () => '/funding/v1/projects'
+} as const;
+
+
 export type getTokenUnlockSupportedAssetsResponse = components['schemas']['TokenUnlockSupportedAsset'][];
 export type getTokenUnlockSupportedAssetsError = components['schemas']['APIError'];