api-integrations

Repository for managing API integrations.

api-data.json

There is api-data.json file for each API provider in data/apis/<api-name>/api-data.json path. This file includes the below information.

• alias: Unique alias used for API.
• providerType: States the type of the provider. It can be either rest or rpc.
• name: Name of the API for public use.
• airnode: Airnode address of the API.
• previousAirnodes: Airnode addresses that APIs used to have before mnemonic rotations.
• xpub: Extended public key.
• supportedFeedsInBatches: Name of the data feeds in batches supported by API, seperated by OIS titles.
• deploymentConfigurations: Deployment configurations describes the APIs deployments.
  • signedApi is a flag that indicates if the API has an Signed API deployment.
  • region is the region that the deployment is made.
  • provider is indicates the deployment location. It could be aws or local.
• homepageUrl: API provider's website's homepage URL.
• verifiedBaseUrl: URL where includes API provider's Airnode address in it's TXT records for people to be able to be confirm the Airnode address.
• signedApiUrl: URL for the Signed API deployed by the API provider.
• productionSignedApiUrls: URLs of the Signed APIs where Airnode feeds deployed by the API provider push data to.
• stagingSignedApiUrl: URL of the Signed API where staging Airnode feed deployed by the API provider push data to.

Mock APIs

Before adding a new dAPI, we survey it for the following reasons:

• Assessing the data quality of the dAPI.
• Estimating the update count for the dAPI.

Since Airnode feed redeployments with partner API providers occur monthly, we maintain a mock version of each API that mirrors the management processes of the actual APIs. The primary difference between a mock API and an actual API is that we handle Airnode feed deployments for the mock APIs ourselves, allowing flexibility during the surveying step.

When a new dAPI is to be added to the market, the related data feeds are first added to the mock version of the actual API. After surveying, they are then added to the actual API just before the Airnode feed redeployments (Fints).