1. Packages
  2. Airbyte Provider
  3. API Docs
  4. SourcePolygonStockApi
airbyte 0.7.0-beta2 published on Friday, Mar 7, 2025 by airbytehq

airbyte.SourcePolygonStockApi

Explore with Pulumi AI

SourcePolygonStockAPI 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.SourcePolygonStockApi;
import com.pulumi.airbyte.SourcePolygonStockApiArgs;
import com.pulumi.airbyte.inputs.SourcePolygonStockApiConfigurationArgs;
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 mySourcePolygonstockapi = new SourcePolygonStockApi("mySourcePolygonstockapi", SourcePolygonStockApiArgs.builder()
            .configuration(SourcePolygonStockApiConfigurationArgs.builder()
                .adjusted("true")
                .api_key("...my_api_key...")
                .end_date("2020-10-14")
                .limit(100)
                .multiplier(1)
                .sort("asc")
                .start_date("2020-10-14")
                .stocks_ticker("IBM")
                .timespan("day")
                .build())
            .definitionId("4b695283-4e49-4369-9fc3-8a9878680f1b")
            .secretId("...my_secret_id...")
            .workspaceId("107f0754-ac3a-433a-939c-817661495e42")
            .build());

    }
}
Copy
resources:
  mySourcePolygonstockapi:
    type: airbyte:SourcePolygonStockApi
    properties:
      configuration:
        adjusted: 'true'
        api_key: '...my_api_key...'
        end_date: 2020-10-14
        limit: 100
        multiplier: 1
        sort: asc
        start_date: 2020-10-14
        stocks_ticker: IBM
        timespan: day
      definitionId: 4b695283-4e49-4369-9fc3-8a9878680f1b
      secretId: '...my_secret_id...'
      workspaceId: 107f0754-ac3a-433a-939c-817661495e42
Copy

Create SourcePolygonStockApi Resource

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

Constructor syntax

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

@overload
def SourcePolygonStockApi(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          configuration: Optional[SourcePolygonStockApiConfigurationArgs] = None,
                          workspace_id: Optional[str] = None,
                          definition_id: Optional[str] = None,
                          name: Optional[str] = None,
                          secret_id: Optional[str] = None)
func NewSourcePolygonStockApi(ctx *Context, name string, args SourcePolygonStockApiArgs, opts ...ResourceOption) (*SourcePolygonStockApi, error)
public SourcePolygonStockApi(string name, SourcePolygonStockApiArgs args, CustomResourceOptions? opts = null)
public SourcePolygonStockApi(String name, SourcePolygonStockApiArgs args)
public SourcePolygonStockApi(String name, SourcePolygonStockApiArgs args, CustomResourceOptions options)
type: airbyte:SourcePolygonStockApi
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. SourcePolygonStockApiArgs
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. SourcePolygonStockApiArgs
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. SourcePolygonStockApiArgs
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. SourcePolygonStockApiArgs
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. SourcePolygonStockApiArgs
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 sourcePolygonStockApiResource = new Airbyte.SourcePolygonStockApi("sourcePolygonStockApiResource", new()
{
    Configuration = new Airbyte.Inputs.SourcePolygonStockApiConfigurationArgs
    {
        ApiKey = "string",
        EndDate = "string",
        Multiplier = 0,
        StartDate = "string",
        StocksTicker = "string",
        Timespan = "string",
        Adjusted = "string",
        Limit = 0,
        Sort = "string",
    },
    WorkspaceId = "string",
    DefinitionId = "string",
    Name = "string",
    SecretId = "string",
});
Copy
example, err := airbyte.NewSourcePolygonStockApi(ctx, "sourcePolygonStockApiResource", &airbyte.SourcePolygonStockApiArgs{
Configuration: &.SourcePolygonStockApiConfigurationArgs{
ApiKey: pulumi.String("string"),
EndDate: pulumi.String("string"),
Multiplier: pulumi.Float64(0),
StartDate: pulumi.String("string"),
StocksTicker: pulumi.String("string"),
Timespan: pulumi.String("string"),
Adjusted: pulumi.String("string"),
Limit: pulumi.Float64(0),
Sort: pulumi.String("string"),
},
WorkspaceId: pulumi.String("string"),
DefinitionId: pulumi.String("string"),
Name: pulumi.String("string"),
SecretId: pulumi.String("string"),
})
Copy
var sourcePolygonStockApiResource = new SourcePolygonStockApi("sourcePolygonStockApiResource", SourcePolygonStockApiArgs.builder()
    .configuration(SourcePolygonStockApiConfigurationArgs.builder()
        .apiKey("string")
        .endDate("string")
        .multiplier(0)
        .startDate("string")
        .stocksTicker("string")
        .timespan("string")
        .adjusted("string")
        .limit(0)
        .sort("string")
        .build())
    .workspaceId("string")
    .definitionId("string")
    .name("string")
    .secretId("string")
    .build());
Copy
source_polygon_stock_api_resource = airbyte.SourcePolygonStockApi("sourcePolygonStockApiResource",
    configuration={
        "api_key": "string",
        "end_date": "string",
        "multiplier": 0,
        "start_date": "string",
        "stocks_ticker": "string",
        "timespan": "string",
        "adjusted": "string",
        "limit": 0,
        "sort": "string",
    },
    workspace_id="string",
    definition_id="string",
    name="string",
    secret_id="string")
Copy
const sourcePolygonStockApiResource = new airbyte.SourcePolygonStockApi("sourcePolygonStockApiResource", {
    configuration: {
        apiKey: "string",
        endDate: "string",
        multiplier: 0,
        startDate: "string",
        stocksTicker: "string",
        timespan: "string",
        adjusted: "string",
        limit: 0,
        sort: "string",
    },
    workspaceId: "string",
    definitionId: "string",
    name: "string",
    secretId: "string",
});
Copy
type: airbyte:SourcePolygonStockApi
properties:
    configuration:
        adjusted: string
        apiKey: string
        endDate: string
        limit: 0
        multiplier: 0
        sort: string
        startDate: string
        stocksTicker: string
        timespan: string
    definitionId: string
    name: string
    secretId: string
    workspaceId: string
Copy

SourcePolygonStockApi 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 SourcePolygonStockApi resource accepts the following input properties:

Configuration This property is required. SourcePolygonStockApiConfiguration
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. SourcePolygonStockApiConfigurationArgs
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. SourcePolygonStockApiConfiguration
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. SourcePolygonStockApiConfiguration
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. SourcePolygonStockApiConfigurationArgs
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 SourcePolygonStockApi resource produces the following output properties:

CreatedAt double
Id string
The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string
CreatedAt float64
Id string
The provider-assigned unique ID for this managed resource.
SourceId string
SourceType string
createdAt Double
id String
The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String
createdAt number
id string
The provider-assigned unique ID for this managed resource.
sourceId string
sourceType string
created_at float
id str
The provider-assigned unique ID for this managed resource.
source_id str
source_type str
createdAt Number
id String
The provider-assigned unique ID for this managed resource.
sourceId String
sourceType String

Look up Existing SourcePolygonStockApi Resource

Get an existing SourcePolygonStockApi 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?: SourcePolygonStockApiState, opts?: CustomResourceOptions): SourcePolygonStockApi
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[SourcePolygonStockApiConfigurationArgs] = None,
        created_at: Optional[float] = None,
        definition_id: Optional[str] = None,
        name: Optional[str] = None,
        secret_id: Optional[str] = None,
        source_id: Optional[str] = None,
        source_type: Optional[str] = None,
        workspace_id: Optional[str] = None) -> SourcePolygonStockApi
func GetSourcePolygonStockApi(ctx *Context, name string, id IDInput, state *SourcePolygonStockApiState, opts ...ResourceOption) (*SourcePolygonStockApi, error)
public static SourcePolygonStockApi Get(string name, Input<string> id, SourcePolygonStockApiState? state, CustomResourceOptions? opts = null)
public static SourcePolygonStockApi get(String name, Output<String> id, SourcePolygonStockApiState state, CustomResourceOptions options)
resources:  _:    type: airbyte:SourcePolygonStockApi    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 SourcePolygonStockApiConfiguration
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
Configuration SourcePolygonStockApiConfigurationArgs
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.
SecretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
SourceId string
SourceType string
WorkspaceId string
configuration SourcePolygonStockApiConfiguration
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String
configuration SourcePolygonStockApiConfiguration
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.
secretId string
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId string
sourceType string
workspaceId string
configuration SourcePolygonStockApiConfigurationArgs
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.
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.
secretId String
Optional secretID obtained through the public API OAuth redirect flow. Requires replacement if changed.
sourceId String
sourceType String
workspaceId String

Supporting Types

SourcePolygonStockApiConfiguration
, SourcePolygonStockApiConfigurationArgs

ApiKey This property is required. string
Your API ACCESS Key
EndDate This property is required. string
The target date for the aggregate window.
Multiplier This property is required. double
The size of the timespan multiplier.
StartDate This property is required. string
The beginning date for the aggregate window.
StocksTicker This property is required. string
The exchange symbol that this item is traded under.
Timespan This property is required. string
The size of the time window.
Adjusted string
Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.
Limit double
The target date for the aggregate window.
Sort string
Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).
ApiKey This property is required. string
Your API ACCESS Key
EndDate This property is required. string
The target date for the aggregate window.
Multiplier This property is required. float64
The size of the timespan multiplier.
StartDate This property is required. string
The beginning date for the aggregate window.
StocksTicker This property is required. string
The exchange symbol that this item is traded under.
Timespan This property is required. string
The size of the time window.
Adjusted string
Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.
Limit float64
The target date for the aggregate window.
Sort string
Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).
apiKey This property is required. String
Your API ACCESS Key
endDate This property is required. String
The target date for the aggregate window.
multiplier This property is required. Double
The size of the timespan multiplier.
startDate This property is required. String
The beginning date for the aggregate window.
stocksTicker This property is required. String
The exchange symbol that this item is traded under.
timespan This property is required. String
The size of the time window.
adjusted String
Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.
limit Double
The target date for the aggregate window.
sort String
Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).
apiKey This property is required. string
Your API ACCESS Key
endDate This property is required. string
The target date for the aggregate window.
multiplier This property is required. number
The size of the timespan multiplier.
startDate This property is required. string
The beginning date for the aggregate window.
stocksTicker This property is required. string
The exchange symbol that this item is traded under.
timespan This property is required. string
The size of the time window.
adjusted string
Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.
limit number
The target date for the aggregate window.
sort string
Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).
api_key This property is required. str
Your API ACCESS Key
end_date This property is required. str
The target date for the aggregate window.
multiplier This property is required. float
The size of the timespan multiplier.
start_date This property is required. str
The beginning date for the aggregate window.
stocks_ticker This property is required. str
The exchange symbol that this item is traded under.
timespan This property is required. str
The size of the time window.
adjusted str
Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.
limit float
The target date for the aggregate window.
sort str
Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).
apiKey This property is required. String
Your API ACCESS Key
endDate This property is required. String
The target date for the aggregate window.
multiplier This property is required. Number
The size of the timespan multiplier.
startDate This property is required. String
The beginning date for the aggregate window.
stocksTicker This property is required. String
The exchange symbol that this item is traded under.
timespan This property is required. String
The size of the time window.
adjusted String
Determines whether or not the results are adjusted for splits. By default, results are adjusted and set to true. Set this to false to get results that are NOT adjusted for splits.
limit Number
The target date for the aggregate window.
sort String
Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top).

Import

$ pulumi import airbyte:index/sourcePolygonStockApi:SourcePolygonStockApi my_airbyte_source_polygon_stock_api ""
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.