chainstack/openapi/chainstack-faucet-api-openapi.yml at main · api-evangelist/chainstack · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
openapi: 3.2.0
info:
  x-logo:
    url: https://chainstack.com/assets/docs/api-docs-logo.svg
    backgroundColor: '#F5F8FC'
    altText: Chainstack
  title: 💙 CHAINSTACK PLATFORM Faucet API
  version: v2
  contact:
    name: API Support
    email: support@chainstack.com
  description: 'A set of API endpoints to operate and manage the platform resources.


    See also a quick API tutorial.'
servers:
- url: https://api.chainstack.com
  description: API endpoint
tags:
- name: Faucet
paths:
  /v1/faucet/sepolia:
    post:
      operationId: sepoliaGoerli
      summary: Sepolia Faucet
      description: Request test tokens.
      tags:
      - Faucet
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FaucetSepoliaRequest'
            examples:
              value:
                value:
                  address: '0x1111111111111111111111111111111111111111'
        required: true
      security:
      - APIKeyAuthentication: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaucetSepoliaResponse'
              examples:
                value:
                  value:
                    amountSent: 500000000000000000
                    transaction: https://sepolia.etherscan.io/tx/0x1111111111111111111111111111111111111111111111111111111111111111
        '400':
          $ref: '#/components/responses/ValidationError'
        '429':
          $ref: '#/components/responses/TooManyRequestsError'
components:
  schemas:
    FaucetSepoliaResponse:
      type: object
      properties:
        amountSent:
          type: number
          description: Amount of tokens sent.
        transaction:
          type: string
          description: Transaction details URL.
    FaucetSepoliaRequest:
      type: object
      properties:
        address:
          type: string
          description: Address to send tokens to.
  responses:
    TooManyRequestsError:
      description: Validation error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: A string indicating the kind of error.
                  message:
                    type: string
                    description: A human-readable description of the error.
              nextFaucetAvailable:
                type: string
                description: The date when tokens can be requested next time.
    ValidationError:
      description: Validation error.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: A string indicating the kind of error.
                  message:
                    type: string
                    description: A human-readable description of the error.
                  fields:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                    description: Optional. Field-level validation errors.
  securitySchemes:
    APIKeyAuthentication:
      type: http
      scheme: bearer
      description: 'Chainstack API uses [API keys](https://docs.chainstack.com/reference/platform-api-getting-started) to authenticate requests. You can view and manage your API keys in the platform UI.

        Your API keys carry many privileges, so be sure to keep them secure!

        Provide your API key as the `Authorization` header. The value of the header consists of `Bearer` prefix and secret key generated through the platform UI.


        ```bash

        curl -X GET ''https://api.chainstack.com/v1/organization/'' \

        --header ''Authorization: Bearer FX7CWlLg.FMpAO8cgCX2N7s41EncRru2nb5CmTZUt''

        ```


        All API requests must be made over HTTPS.

        '