1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourceFinnhub
airbyte 0.9.0 published on Wednesday, Apr 9, 2025 by airbytehq

airbyte.SourceFinnhub

Explore with Pulumi AI

SourceFinnhub Resource

Example Usage

Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.airbyte.SourceFinnhub;
import com.pulumi.airbyte.SourceFinnhubArgs;
import com.pulumi.airbyte.inputs.SourceFinnhubConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var mySourceFinnhub = new SourceFinnhub("mySourceFinnhub", SourceFinnhubArgs.builder()
            .configuration(SourceFinnhubConfigurationArgs.builder()
                .api_key("...my_api_key...")
                .exchange("...my_exchange...")
                .market_news_category("general")
                .start_date_2("2022-05-18T12:51:37.658Z")
                .symbols("{ \"see\": \"documentation\" }")
                .build())
            .definitionId("426504bb-5bb9-490a-9b4d-4bbfe4324584")
            .secretId("...my_secret_id...")
            .workspaceId("42be0db2-a152-4027-a103-e5e0ac5819d4")
            .build());

    }
}
Copy
resources:
  mySourceFinnhub:
    type: airbyte:SourceFinnhub
    properties:
      configuration:
        api_key: '...my_api_key...'
        exchange: '...my_exchange...'
        market_news_category: general
        start_date_2: 2022-05-18T12:51:37.658Z
        symbols:
          - '{ "see": "documentation" }'
      definitionId: 426504bb-5bb9-490a-9b4d-4bbfe4324584
      secretId: '...my_secret_id...'
      workspaceId: 42be0db2-a152-4027-a103-e5e0ac5819d4
Copy

Create SourceFinnhub Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new SourceFinnhub(name: string, args: SourceFinnhubArgs, opts?: CustomResourceOptions);
@overload
def SourceFinnhub(resource_name: str,
                  args: SourceFinnhubArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def SourceFinnhub(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  configuration: Optional[SourceFinnhubConfigurationArgs] = None,
                  workspace_id: Optional[str] = None,
                  definition_id: Optional[str] = None,
                  name: Optional[str] = None,
                  secret_id: Optional[str] = None)
func NewSourceFinnhub(ctx *Context, name string, args SourceFinnhubArgs, opts ...ResourceOption) (*SourceFinnhub, error)
public SourceFinnhub(string name, SourceFinnhubArgs args, CustomResourceOptions? opts = null)
public SourceFinnhub(String name, SourceFinnhubArgs args)
public SourceFinnhub(String name, SourceFinnhubArgs args, CustomResourceOptions options)
type: airbyte:SourceFinnhub
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. SourceFinnhubArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. SourceFinnhubArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. SourceFinnhubArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. SourceFinnhubArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. SourceFinnhubArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var sourceFinnhubResource = new Airbyte.SourceFinnhub("sourceFinnhubResource", new()
{
    Configuration = new Airbyte.Inputs.SourceFinnhubConfigurationArgs
    {
        ApiKey = "string",
        StartDate2 = "string",
        Symbols = new[]
        {
            "string",
        },
        Exchange = "string",
        MarketNewsCategory = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourceFinnhub(ctx, "sourceFinnhubResource", &airbyte.SourceFinnhubArgs{
Configuration: &.SourceFinnhubConfigurationArgs{
ApiKey: pulumi.String("string"),
StartDate2: pulumi.String("string"),
Symbols: pulumi.StringArray{
pulumi.String("string"),
},
Exchange: pulumi.String("string"),
MarketNewsCategory: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourceFinnhubResource = new SourceFinnhub("sourceFinnhubResource", SourceFinnhubArgs.builder()
    .configuration(SourceFinnhubConfigurationArgs.builder()
        .apiKey("string")
        .startDate2("string")
        .symbols("string")
        .exchange("string")
        .marketNewsCategory("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_finnhub_resource = airbyte.SourceFinnhub("sourceFinnhubResource",
    configuration={
        "api_key": "string",
        "start_date2": "string",
        "symbols": ["string"],
        "exchange": "string",
        "market_news_category": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourceFinnhubResource = new airbyte.SourceFinnhub("sourceFinnhubResource", {
    configuration: {
        apiKey: "string",
        startDate2: "string",
        symbols: ["string"],
        exchange: "string",
        marketNewsCategory: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourceFinnhub
properties:
    configuration:
        apiKey: string
        exchange: string
        marketNewsCategory: string
        startDate2: string
        symbols:
            - string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourceFinnhub Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The SourceFinnhub resource accepts the following input properties:

Configuration This property is required. SourceFinnhubConfiguration
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
Configuration This property is required. SourceFinnhubConfigurationArgs
WorkspaceId This property is required. string
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceFinnhubConfiguration
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceFinnhubConfiguration
workspaceId This property is required. string
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. SourceFinnhubConfigurationArgs
workspace_id This property is required. str
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
configuration This property is required. Property Map
workspaceId This property is required. String
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the SourceFinnhub resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
ResourceAllocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
resourceAllocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
resource_allocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
sourceId String
sourceType String

Look up Existing SourceFinnhub Resource

Get an existing SourceFinnhub resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SourceFinnhubState, opts?: CustomResourceOptions): SourceFinnhub
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourceFinnhubConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        resource_allocation: Optional[SourceFinnhubResourceAllocationArgs] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourceFinnhub
func GetSourceFinnhub(ctx *Context, name string, id IDInput, state *SourceFinnhubState, opts ...ResourceOption) (*SourceFinnhub, error)
public static SourceFinnhub Get(string name, Input<string> id, SourceFinnhubState? state, CustomResourceOptions? opts = null)
public static SourceFinnhub get(String name, Output<String> id, SourceFinnhubState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourceFinnhub    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Configuration SourceFinnhubConfiguration
CreatedAt double
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourceFinnhubConfigurationArgs
CreatedAt float64
DefinitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
Name string
Name of the source e.g. dev-mysql-instance.
ResourceAllocation SourceFinnhubResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourceFinnhubConfiguration
createdAt Double
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourceFinnhubConfiguration
createdAt number
definitionId string
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name string
Name of the source e.g. dev-mysql-instance.
resourceAllocation SourceFinnhubResourceAllocation
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourceFinnhubConfigurationArgs
created_at float
definition_id str
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name str
Name of the source e.g. dev-mysql-instance.
resource_allocation SourceFinnhubResourceAllocationArgs
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secret_id str
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
source_id str
source_type str
workspace_id str
configuration Property Map
createdAt Number
definitionId String
The UUID of the connector definition. One of configuration.sourceType or definitionId must be provided. Requires replacement if changed.
name String
Name of the source e.g. dev-mysql-instance.
resourceAllocation Property Map
actor or actor definition specific resource requirements. if default is set, these are the requirements that should be set for ALL jobs run for this actor definition. it is overriden by the job type specific configurations. if not set, the platform will use defaults. these values will be overriden by configuration at the connection level.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourceFinnhubConfiguration
, SourceFinnhubConfigurationArgs

ApiKey This property is required. string
The API key to use for authentication
StartDate2 This property is required. string
Symbols This property is required. List<string>
Exchange string
More info: https://finnhub.io/docs/api/stock-symbols. Default: "US"
MarketNewsCategory string
This parameter can be 1 of the following values general, forex, crypto, merger. Default: "general"; must be one of ["general", "forex", "crypto", "merger"]
ApiKey This property is required. string
The API key to use for authentication
StartDate2 This property is required. string
Symbols This property is required. []string
Exchange string
More info: https://finnhub.io/docs/api/stock-symbols. Default: "US"
MarketNewsCategory string
This parameter can be 1 of the following values general, forex, crypto, merger. Default: "general"; must be one of ["general", "forex", "crypto", "merger"]
apiKey This property is required. String
The API key to use for authentication
startDate2 This property is required. String
symbols This property is required. List<String>
exchange String
More info: https://finnhub.io/docs/api/stock-symbols. Default: "US"
marketNewsCategory String
This parameter can be 1 of the following values general, forex, crypto, merger. Default: "general"; must be one of ["general", "forex", "crypto", "merger"]
apiKey This property is required. string
The API key to use for authentication
startDate2 This property is required. string
symbols This property is required. string[]
exchange string
More info: https://finnhub.io/docs/api/stock-symbols. Default: "US"
marketNewsCategory string
This parameter can be 1 of the following values general, forex, crypto, merger. Default: "general"; must be one of ["general", "forex", "crypto", "merger"]
api_key This property is required. str
The API key to use for authentication
start_date2 This property is required. str
symbols This property is required. Sequence[str]
exchange str
More info: https://finnhub.io/docs/api/stock-symbols. Default: "US"
market_news_category str
This parameter can be 1 of the following values general, forex, crypto, merger. Default: "general"; must be one of ["general", "forex", "crypto", "merger"]
apiKey This property is required. String
The API key to use for authentication
startDate2 This property is required. String
symbols This property is required. List<String>
exchange String
More info: https://finnhub.io/docs/api/stock-symbols. Default: "US"
marketNewsCategory String
This parameter can be 1 of the following values general, forex, crypto, merger. Default: "general"; must be one of ["general", "forex", "crypto", "merger"]

SourceFinnhubResourceAllocation
, SourceFinnhubResourceAllocationArgs

Default SourceFinnhubResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics List<SourceFinnhubResourceAllocationJobSpecific>
Default SourceFinnhubResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
JobSpecifics []SourceFinnhubResourceAllocationJobSpecific
default_ SourceFinnhubResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<SourceFinnhubResourceAllocationJobSpecific>
default SourceFinnhubResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics SourceFinnhubResourceAllocationJobSpecific[]
default SourceFinnhubResourceAllocationDefault
optional resource requirements to run workers (blank for unbounded allocations)
job_specifics Sequence[SourceFinnhubResourceAllocationJobSpecific]
default Property Map
optional resource requirements to run workers (blank for unbounded allocations)
jobSpecifics List<Property Map>

SourceFinnhubResourceAllocationDefault
, SourceFinnhubResourceAllocationDefaultArgs

SourceFinnhubResourceAllocationJobSpecific
, SourceFinnhubResourceAllocationJobSpecificArgs

JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceFinnhubResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
JobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
ResourceRequirements SourceFinnhubResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceFinnhubResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType string
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements SourceFinnhubResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
job_type str
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resource_requirements SourceFinnhubResourceAllocationJobSpecificResourceRequirements
optional resource requirements to run workers (blank for unbounded allocations)
jobType String
enum that describes the different types of jobs that the platform runs. must be one of ["getspec", "checkconnection", "discoverschema", "sync", "resetconnection", "connection_updater", "replicate"]
resourceRequirements Property Map
optional resource requirements to run workers (blank for unbounded allocations)

SourceFinnhubResourceAllocationJobSpecificResourceRequirements
, SourceFinnhubResourceAllocationJobSpecificResourceRequirementsArgs

Import

$ pulumi import airbyte:index/sourceFinnhub:SourceFinnhub my_airbyte_source_finnhub ""
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
airbyte airbytehq/terraform-provider-airbyte
License
Notes
This Pulumi package is based on the airbyte Terraform Provider.