Skip to content

Latest commit

 

History

History
301 lines (198 loc) · 8.64 KB

MunicipalityApi.md

File metadata and controls

301 lines (198 loc) · 8.64 KB

Intrinio.SDK.Api.MunicipalityApi

All URIs are relative to https://api-v2.intrinio.com

Method HTTP request Description
GetAllMunicipalities GET /municipalities All Municipalities
GetMunicipalityById GET /municipalities/{id} Municipality by ID
GetMunicipalityFinancials GET /municipalities/{id}/financials Financials for a Municipality

GetAllMunicipalities

View Intrinio API Documentation

ApiResponseMunicipalities GetAllMunicipalities (bool? hasFinancials = null, string governmentName = null, string governmentType = null, string areaName = null, string areaType = null, string city = null, string state = null, decimal? zipcode = null, decimal? populationGreaterThan = null, decimal? populationLessThan = null, decimal? enrollmentGreaterThan = null, decimal? enrollmentLessThan = null, string nextPage = null)

All Municipalities

Returns all Municipalities. When parameters are specified, returns matching municipalities.

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetAllMunicipalitiesExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var municipalityApi = new MunicipalityApi();
      
      bool? hasFinancials = null;
      string governmentName = null;
      string governmentType = null;
      string areaName = null;
      string areaType = null;
      string city = null;
      string state = null;
      decimal? zipcode = null;
      decimal? populationGreaterThan = null;
      decimal? populationLessThan = null;
      decimal? enrollmentGreaterThan = null;
      decimal? enrollmentLessThan = null;
      string nextPage = null;
      
      ApiResponseMunicipalities result = municipalityApi.GetAllMunicipalities(hasFinancials, governmentName, governmentType, areaName, areaType, city, state, zipcode, populationGreaterThan, populationLessThan, enrollmentGreaterThan, enrollmentLessThan, nextPage);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
hasFinancials bool? Return municipalities with financials [optional]  
governmentName string Return municipalities with a government name matching the given query [optional]  
governmentType string Return municipalities with the given government type [optional]  
areaName string Return municipalities with an area name matching the given query [optional]  
areaType string Return municipalities with the given area type [optional]  
city string Return municipalities in the given city [optional]  
state string Return municipalities in the given state [optional]  
zipcode decimal? Return municipalities in the given zipcode [optional]  
populationGreaterThan decimal? Return municipalities with a population greater than the given number [optional]  
populationLessThan decimal? Return municipalities with a population less than the given number [optional]  
enrollmentGreaterThan decimal? Return municipalities with an enrollment greater than the given number [optional]  
enrollmentLessThan decimal? Return municipalities with an enrollment less than the given number [optional]  
nextPage string Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseMunicipalities

GetMunicipalityById

View Intrinio API Documentation

Municipality GetMunicipalityById (string id)

Municipality by ID

Returns the Municipality with the given ID

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetMunicipalityByIdExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var municipalityApi = new MunicipalityApi();
      
      string id = "mun_Xn7x4z";
      
      Municipality result = municipalityApi.GetMunicipalityById(id);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
id string An Intrinio ID of a Municipality  

Return type

Municipality

GetMunicipalityFinancials

View Intrinio API Documentation

ApiResponseMunicipalitiyFinancials GetMunicipalityFinancials (string id, decimal? fiscalYear = null)

Financials for a Municipality

Returns financial statement data for the Municipality with the given ID

Example

using System;
using System.Diagnostics;
using System.Collections;
using System.Collections.Generic;
using Intrinio.SDK.Api;
using Intrinio.SDK.Client;
using Intrinio.SDK.Model;
using Newtonsoft.Json;

namespace Example
{
  public class GetMunicipalityFinancialsExample
  {
    public static void Main()
    {
      Configuration.Default.AddApiKey("api_key", "YOUR_API_KEY");
      Configuration.Default.AllowRetries = true;
      
      var municipalityApi = new MunicipalityApi();
      
      string id = "mun_Xn7x4z";
      decimal? fiscalYear = 2017;
      
      ApiResponseMunicipalitiyFinancials result = municipalityApi.GetMunicipalityFinancials(id, fiscalYear);
      Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
    }
  }
}

Parameters

Name Type Description Notes
id string An Intrinio ID of a Municipality  
fiscalYear decimal? Return financials for the given fiscal year [optional]  

Return type

ApiResponseMunicipalitiyFinancials